Liferay 6.2-ce-ga5

com.liferay.portlet.documentlibrary.service
Class DLFileShortcutLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.service.DLFileShortcutLocalServiceUtil

@ProviderType
public class DLFileShortcutLocalServiceUtil
extends Object

Provides the local service utility for DLFileShortcut. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
DLFileShortcutLocalService, com.liferay.portlet.documentlibrary.service.base.DLFileShortcutLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl

Constructor Summary
DLFileShortcutLocalServiceUtil()
           
 
Method Summary
static DLFileShortcut addDLFileShortcut(DLFileShortcut dlFileShortcut)
          Adds the document library file shortcut to the database.
static DLFileShortcut addFileShortcut(long userId, long groupId, long folderId, long toFileEntryId, ServiceContext serviceContext)
           
static void addFileShortcutResources(DLFileShortcut fileShortcut, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addFileShortcutResources(DLFileShortcut fileShortcut, String[] groupPermissions, String[] guestPermissions)
           
static void addFileShortcutResources(long fileShortcutId, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addFileShortcutResources(long fileShortcutId, String[] groupPermissions, String[] guestPermissions)
           
static DLFileShortcut createDLFileShortcut(long fileShortcutId)
          Creates a new document library file shortcut with the primary key.
static DLFileShortcut deleteDLFileShortcut(DLFileShortcut dlFileShortcut)
          Deletes the document library file shortcut from the database.
static DLFileShortcut deleteDLFileShortcut(long fileShortcutId)
          Deletes the document library file shortcut with the primary key from the database.
static void deleteFileShortcut(DLFileShortcut fileShortcut)
           
static void deleteFileShortcut(long fileShortcutId)
           
static void deleteFileShortcuts(long toFileEntryId)
           
static void deleteFileShortcuts(long groupId, long folderId)
           
static void deleteFileShortcuts(long groupId, long folderId, boolean includeTrashedEntries)
           
static void disableFileShortcuts(long toFileEntryId)
           
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static void enableFileShortcuts(long toFileEntryId)
           
static DLFileShortcut fetchDLFileShortcut(long fileShortcutId)
           
static DLFileShortcut fetchDLFileShortcutByUuidAndCompanyId(String uuid, long companyId)
          Returns the document library file shortcut with the matching UUID and company.
static DLFileShortcut fetchDLFileShortcutByUuidAndGroupId(String uuid, long groupId)
          Returns the document library file shortcut matching the UUID and group.
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static DLFileShortcut getDLFileShortcut(long fileShortcutId)
          Returns the document library file shortcut with the primary key.
static DLFileShortcut getDLFileShortcutByUuidAndCompanyId(String uuid, long companyId)
          Returns the document library file shortcut with the matching UUID and company.
static DLFileShortcut getDLFileShortcutByUuidAndGroupId(String uuid, long groupId)
          Returns the document library file shortcut matching the UUID and group.
static List<DLFileShortcut> getDLFileShortcuts(int start, int end)
          Returns a range of all the document library file shortcuts.
static int getDLFileShortcutsCount()
          Returns the number of document library file shortcuts.
static DLFileShortcut getFileShortcut(long fileShortcutId)
           
static List<DLFileShortcut> getFileShortcuts(long groupId, long folderId, boolean active, int status, int start, int end)
           
static int getFileShortcutsCount(long groupId, long folderId, boolean active, int status)
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static DLFileShortcutLocalService getService()
           
static void rebuildTree(long companyId)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(DLFileShortcutLocalService service)
          Deprecated. As of 6.2.0
static void setTreePaths(long folderId, String treePath)
           
static void updateAsset(long userId, DLFileShortcut fileShortcut, long[] assetCategoryIds, String[] assetTagNames)
           
static DLFileShortcut updateDLFileShortcut(DLFileShortcut dlFileShortcut)
          Updates the document library file shortcut in the database or adds it if it does not yet exist.
static DLFileShortcut updateFileShortcut(long userId, long fileShortcutId, long folderId, long toFileEntryId, ServiceContext serviceContext)
           
static void updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId)
           
static void updateStatus(long userId, long fileShortcutId, int status, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLFileShortcutLocalServiceUtil

public DLFileShortcutLocalServiceUtil()
Method Detail

addDLFileShortcut

public static DLFileShortcut addDLFileShortcut(DLFileShortcut dlFileShortcut)
                                        throws SystemException
Adds the document library file shortcut to the database. Also notifies the appropriate model listeners.

Parameters:
dlFileShortcut - the document library file shortcut
Returns:
the document library file shortcut that was added
Throws:
SystemException - if a system exception occurred

createDLFileShortcut

public static DLFileShortcut createDLFileShortcut(long fileShortcutId)
Creates a new document library file shortcut with the primary key. Does not add the document library file shortcut to the database.

Parameters:
fileShortcutId - the primary key for the new document library file shortcut
Returns:
the new document library file shortcut

deleteDLFileShortcut

public static DLFileShortcut deleteDLFileShortcut(long fileShortcutId)
                                           throws PortalException,
                                                  SystemException
Deletes the document library file shortcut with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
fileShortcutId - the primary key of the document library file shortcut
Returns:
the document library file shortcut that was removed
Throws:
PortalException - if a document library file shortcut with the primary key could not be found
SystemException - if a system exception occurred

deleteDLFileShortcut

public static DLFileShortcut deleteDLFileShortcut(DLFileShortcut dlFileShortcut)
                                           throws SystemException
Deletes the document library file shortcut from the database. Also notifies the appropriate model listeners.

Parameters:
dlFileShortcut - the document library file shortcut
Returns:
the document library file shortcut that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFileShortcutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFileShortcutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchDLFileShortcut

public static DLFileShortcut fetchDLFileShortcut(long fileShortcutId)
                                          throws SystemException
Throws:
SystemException

fetchDLFileShortcutByUuidAndCompanyId

public static DLFileShortcut fetchDLFileShortcutByUuidAndCompanyId(String uuid,
                                                                   long companyId)
                                                            throws SystemException
Returns the document library file shortcut with the matching UUID and company.

Parameters:
uuid - the document library file shortcut's UUID
companyId - the primary key of the company
Returns:
the matching document library file shortcut, or null if a matching document library file shortcut could not be found
Throws:
SystemException - if a system exception occurred

fetchDLFileShortcutByUuidAndGroupId

public static DLFileShortcut fetchDLFileShortcutByUuidAndGroupId(String uuid,
                                                                 long groupId)
                                                          throws SystemException
Returns the document library file shortcut matching the UUID and group.

Parameters:
uuid - the document library file shortcut's UUID
groupId - the primary key of the group
Returns:
the matching document library file shortcut, or null if a matching document library file shortcut could not be found
Throws:
SystemException - if a system exception occurred

getDLFileShortcut

public static DLFileShortcut getDLFileShortcut(long fileShortcutId)
                                        throws PortalException,
                                               SystemException
Returns the document library file shortcut with the primary key.

Parameters:
fileShortcutId - the primary key of the document library file shortcut
Returns:
the document library file shortcut
Throws:
PortalException - if a document library file shortcut with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getDLFileShortcutByUuidAndCompanyId

public static DLFileShortcut getDLFileShortcutByUuidAndCompanyId(String uuid,
                                                                 long companyId)
                                                          throws PortalException,
                                                                 SystemException
Returns the document library file shortcut with the matching UUID and company.

Parameters:
uuid - the document library file shortcut's UUID
companyId - the primary key of the company
Returns:
the matching document library file shortcut
Throws:
PortalException - if a matching document library file shortcut could not be found
SystemException - if a system exception occurred

getDLFileShortcutByUuidAndGroupId

public static DLFileShortcut getDLFileShortcutByUuidAndGroupId(String uuid,
                                                               long groupId)
                                                        throws PortalException,
                                                               SystemException
Returns the document library file shortcut matching the UUID and group.

Parameters:
uuid - the document library file shortcut's UUID
groupId - the primary key of the group
Returns:
the matching document library file shortcut
Throws:
PortalException - if a matching document library file shortcut could not be found
SystemException - if a system exception occurred

getDLFileShortcuts

public static List<DLFileShortcut> getDLFileShortcuts(int start,
                                                      int end)
                                               throws SystemException
Returns a range of all the document library file shortcuts.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFileShortcutModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
start - the lower bound of the range of document library file shortcuts
end - the upper bound of the range of document library file shortcuts (not inclusive)
Returns:
the range of document library file shortcuts
Throws:
SystemException - if a system exception occurred

getDLFileShortcutsCount

public static int getDLFileShortcutsCount()
                                   throws SystemException
Returns the number of document library file shortcuts.

Returns:
the number of document library file shortcuts
Throws:
SystemException - if a system exception occurred

updateDLFileShortcut

public static DLFileShortcut updateDLFileShortcut(DLFileShortcut dlFileShortcut)
                                           throws SystemException
Updates the document library file shortcut in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
dlFileShortcut - the document library file shortcut
Returns:
the document library file shortcut that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addFileShortcut

public static DLFileShortcut addFileShortcut(long userId,
                                             long groupId,
                                             long folderId,
                                             long toFileEntryId,
                                             ServiceContext serviceContext)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

addFileShortcutResources

public static void addFileShortcutResources(DLFileShortcut fileShortcut,
                                            boolean addGroupPermissions,
                                            boolean addGuestPermissions)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

addFileShortcutResources

public static void addFileShortcutResources(DLFileShortcut fileShortcut,
                                            String[] groupPermissions,
                                            String[] guestPermissions)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

addFileShortcutResources

public static void addFileShortcutResources(long fileShortcutId,
                                            boolean addGroupPermissions,
                                            boolean addGuestPermissions)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

addFileShortcutResources

public static void addFileShortcutResources(long fileShortcutId,
                                            String[] groupPermissions,
                                            String[] guestPermissions)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

deleteFileShortcut

public static void deleteFileShortcut(DLFileShortcut fileShortcut)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

deleteFileShortcut

public static void deleteFileShortcut(long fileShortcutId)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

deleteFileShortcuts

public static void deleteFileShortcuts(long toFileEntryId)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

deleteFileShortcuts

public static void deleteFileShortcuts(long groupId,
                                       long folderId)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

deleteFileShortcuts

public static void deleteFileShortcuts(long groupId,
                                       long folderId,
                                       boolean includeTrashedEntries)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

disableFileShortcuts

public static void disableFileShortcuts(long toFileEntryId)
                                 throws SystemException
Throws:
SystemException

enableFileShortcuts

public static void enableFileShortcuts(long toFileEntryId)
                                throws SystemException
Throws:
SystemException

getFileShortcut

public static DLFileShortcut getFileShortcut(long fileShortcutId)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

getFileShortcuts

public static List<DLFileShortcut> getFileShortcuts(long groupId,
                                                    long folderId,
                                                    boolean active,
                                                    int status,
                                                    int start,
                                                    int end)
                                             throws SystemException
Throws:
SystemException

getFileShortcutsCount

public static int getFileShortcutsCount(long groupId,
                                        long folderId,
                                        boolean active,
                                        int status)
                                 throws SystemException
Throws:
SystemException

rebuildTree

public static void rebuildTree(long companyId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

setTreePaths

public static void setTreePaths(long folderId,
                                String treePath)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

updateAsset

public static void updateAsset(long userId,
                               DLFileShortcut fileShortcut,
                               long[] assetCategoryIds,
                               String[] assetTagNames)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

updateFileShortcut

public static DLFileShortcut updateFileShortcut(long userId,
                                                long fileShortcutId,
                                                long folderId,
                                                long toFileEntryId,
                                                ServiceContext serviceContext)
                                         throws PortalException,
                                                SystemException
Throws:
PortalException
SystemException

updateFileShortcuts

public static void updateFileShortcuts(long oldToFileEntryId,
                                       long newToFileEntryId)
                                throws SystemException
Throws:
SystemException

updateStatus

public static void updateStatus(long userId,
                                long fileShortcutId,
                                int status,
                                ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

getService

public static DLFileShortcutLocalService getService()

setService

public void setService(DLFileShortcutLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5