Class DLFileShortcutLocalServiceUtil

Object
com.liferay.document.library.kernel.service.DLFileShortcutLocalServiceUtil

public class DLFileShortcutLocalServiceUtil extends Object
Provides the local service utility for DLFileShortcut. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLFileShortcutLocalServiceImpl and is an 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.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • DLFileShortcutLocalServiceUtil

      public DLFileShortcutLocalServiceUtil()
  • Method Details

    • addDLFileShortcut

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

      Important: Inspect DLFileShortcutLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      dlFileShortcut - the document library file shortcut
      Returns:
      the document library file shortcut that was added
    • addFileShortcut

      public static DLFileShortcut addFileShortcut(String externalReferenceCode, long userId, long groupId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addFileShortcutResources

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

      public static void addFileShortcutResources(DLFileShortcut fileShortcut, ModelPermissions modelPermissions) throws PortalException
      Throws:
      PortalException
    • addFileShortcutResources

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

      public static void addFileShortcutResources(long fileShortcutId, ModelPermissions modelPermissions) throws PortalException
      Throws:
      PortalException
    • 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
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • deleteDLFileShortcut

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

      Important: Inspect DLFileShortcutLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      dlFileShortcut - the document library file shortcut
      Returns:
      the document library file shortcut that was removed
    • deleteDLFileShortcut

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

      Important: Inspect DLFileShortcutLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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
    • deleteFileShortcut

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

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

      public static void deleteFileShortcut(String externalReferenceCode, long groupId) throws PortalException
      Throws:
      PortalException
    • deleteFileShortcuts

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

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

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

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteRepositoryFileShortcuts

      public static void deleteRepositoryFileShortcuts(long repositoryId) throws PortalException
      Throws:
      PortalException
    • disableFileShortcuts

      public static void disableFileShortcuts(long toFileEntryId)
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl.

      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
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl.

      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
    • dynamicQueryCount

      public static long dynamicQueryCount(DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • enableFileShortcuts

      public static void enableFileShortcuts(long toFileEntryId)
    • fetchDLFileShortcut

      public static DLFileShortcut fetchDLFileShortcut(long fileShortcutId)
    • fetchDLFileShortcutByExternalReferenceCode

      public static DLFileShortcut fetchDLFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchDLFileShortcutByUuidAndGroupId

      public static DLFileShortcut fetchDLFileShortcutByUuidAndGroupId(String uuid, long groupId)
      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
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getDLFileShortcut

      public static DLFileShortcut getDLFileShortcut(long fileShortcutId) throws PortalException
      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
    • getDLFileShortcutByExternalReferenceCode

      public static DLFileShortcut getDLFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Throws:
      PortalException
    • getDLFileShortcutByUuidAndGroupId

      public static DLFileShortcut getDLFileShortcutByUuidAndGroupId(String uuid, long groupId) throws PortalException
      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
    • getDLFileShortcuts

      public static List<DLFileShortcut> getDLFileShortcuts(int start, int end)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl.

      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
    • getDLFileShortcutsByUuidAndCompanyId

      public static List<DLFileShortcut> getDLFileShortcutsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the document library file shortcuts matching the UUID and company.
      Parameters:
      uuid - the UUID of the document library file shortcuts
      companyId - the primary key of the company
      Returns:
      the matching document library file shortcuts, or an empty list if no matches were found
    • getDLFileShortcutsByUuidAndCompanyId

      public static List<DLFileShortcut> getDLFileShortcutsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DLFileShortcut> orderByComparator)
      Returns a range of document library file shortcuts matching the UUID and company.
      Parameters:
      uuid - the UUID of the document library file shortcuts
      companyId - the primary key of the company
      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)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching document library file shortcuts, or an empty list if no matches were found
    • getDLFileShortcutsCount

      public static int getDLFileShortcutsCount()
      Returns the number of document library file shortcuts.
      Returns:
      the number of document library file shortcuts
    • getExportActionableDynamicQuery

      public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
    • getFileShortcut

      public static DLFileShortcut getFileShortcut(long fileShortcutId) throws PortalException
      Throws:
      PortalException
    • getFileShortcuts

      public static List<DLFileShortcut> getFileShortcuts(long toFileEntryId)
    • getFileShortcuts

      public static List<DLFileShortcut> getFileShortcuts(long groupId, long folderId)
    • getFileShortcuts

      public static List<DLFileShortcut> getFileShortcuts(long groupId, long folderId, boolean active, int status, int start, int end)
    • getFileShortcutsCount

      public static int getFileShortcutsCount(long groupId, long folderId, boolean active, int status)
    • getGroupFileShortcuts

      public static List<DLFileShortcut> getGroupFileShortcuts(long groupId)
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • rebuildTree

      public static void rebuildTree(long companyId) throws PortalException
      Throws:
      PortalException
    • setTreePaths

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

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

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

      Important: Inspect DLFileShortcutLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      dlFileShortcut - the document library file shortcut
      Returns:
      the document library file shortcut that was updated
    • updateFileShortcut

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

      public static void updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId)
    • updateFileShortcutsActive

      public static void updateFileShortcutsActive(long toFileEntryId, boolean active)
    • updateStatus

      public static DLFileShortcut updateStatus(long userId, long fileShortcutId, int status, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • getService

      public static DLFileShortcutLocalService getService()
    • setService

      public static void setService(DLFileShortcutLocalService service)