Class DLFileShortcutLocalServiceUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic DLFileShortcut
addDLFileShortcut
(DLFileShortcut dlFileShortcut) Adds the document library file shortcut to the database.static DLFileShortcut
addFileShortcut
(String externalReferenceCode, long userId, long groupId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) static void
addFileShortcutResources
(long fileShortcutId, boolean addGroupPermissions, boolean addGuestPermissions) static void
addFileShortcutResources
(long fileShortcutId, ModelPermissions modelPermissions) static void
addFileShortcutResources
(DLFileShortcut fileShortcut, boolean addGroupPermissions, boolean addGuestPermissions) static void
addFileShortcutResources
(DLFileShortcut fileShortcut, ModelPermissions modelPermissions) static DLFileShortcut
createDLFileShortcut
(long fileShortcutId) Creates a new document library file shortcut with the primary key.static PersistedModel
createPersistedModel
(Serializable primaryKeyObj) static DLFileShortcut
deleteDLFileShortcut
(long fileShortcutId) Deletes the document library file shortcut with the primary key from the database.static DLFileShortcut
deleteDLFileShortcut
(DLFileShortcut dlFileShortcut) Deletes the document library file shortcut from the database.static void
deleteFileShortcut
(long fileShortcutId) static void
deleteFileShortcut
(DLFileShortcut fileShortcut) static void
deleteFileShortcut
(String externalReferenceCode, long groupId) static void
deleteFileShortcuts
(long toFileEntryId) static void
deleteFileShortcuts
(long groupId, long folderId) static void
deleteFileShortcuts
(long groupId, long folderId, boolean includeTrashedEntries) static PersistedModel
deletePersistedModel
(PersistedModel persistedModel) static void
deleteRepositoryFileShortcuts
(long repositoryId) static void
disableFileShortcuts
(long toFileEntryId) static <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuery
static <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.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.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.static long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static void
enableFileShortcuts
(long toFileEntryId) static DLFileShortcut
fetchDLFileShortcut
(long fileShortcutId) static DLFileShortcut
fetchDLFileShortcutByExternalReferenceCode
(String externalReferenceCode, long groupId) static DLFileShortcut
fetchDLFileShortcutByUuidAndGroupId
(String uuid, long groupId) Returns the document library file shortcut matching the UUID and group.static ActionableDynamicQuery
static DLFileShortcut
getDLFileShortcut
(long fileShortcutId) Returns the document library file shortcut with the primary key.static DLFileShortcut
getDLFileShortcutByExternalReferenceCode
(String externalReferenceCode, long groupId) 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 List<DLFileShortcut>
getDLFileShortcutsByUuidAndCompanyId
(String uuid, long companyId) Returns all the document library file shortcuts matching the UUID and company.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.static int
Returns the number of document library file shortcuts.static ExportActionableDynamicQuery
getExportActionableDynamicQuery
(PortletDataContext portletDataContext) static DLFileShortcut
getFileShortcut
(long fileShortcutId) static List<DLFileShortcut>
getFileShortcuts
(long toFileEntryId) static List<DLFileShortcut>
getFileShortcuts
(long groupId, long folderId) 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 List<DLFileShortcut>
getGroupFileShortcuts
(long groupId) static String
Returns the OSGi service identifier.static PersistedModel
getPersistedModel
(Serializable primaryKeyObj) static DLFileShortcutLocalService
static void
rebuildTree
(long companyId) static void
setService
(DLFileShortcutLocalService service) 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 repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) static void
updateFileShortcuts
(long oldToFileEntryId, long newToFileEntryId) static void
updateFileShortcutsActive
(long toFileEntryId, boolean active) static DLFileShortcut
updateStatus
(long userId, long fileShortcutId, int status, ServiceContext serviceContext)
-
Constructor Details
-
DLFileShortcutLocalServiceUtil
public DLFileShortcutLocalServiceUtil()
-
-
Method Details
-
addDLFileShortcut
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
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
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
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
- Throws:
PortalException
-
deleteFileShortcut
- Throws:
PortalException
-
deleteFileShortcut
public static void deleteFileShortcut(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
deleteFileShortcuts
- Throws:
PortalException
-
deleteFileShortcuts
- 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
- 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
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
enableFileShortcuts
public static void enableFileShortcuts(long toFileEntryId) -
fetchDLFileShortcut
-
fetchDLFileShortcutByExternalReferenceCode
public static DLFileShortcut fetchDLFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchDLFileShortcutByUuidAndGroupId
Returns the document library file shortcut matching the UUID and group.- Parameters:
uuid
- the document library file shortcut's UUIDgroupId
- 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
-
getDLFileShortcut
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 UUIDgroupId
- 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
Returns a range of all the document library file shortcuts.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.documentlibrary.model.impl.DLFileShortcutModelImpl
.- Parameters:
start
- the lower bound of the range of document library file shortcutsend
- 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 shortcutscompanyId
- 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 shortcutscompanyId
- the primary key of the companystart
- the lower bound of the range of document library file shortcutsend
- the upper bound of the range of document library file shortcuts (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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
- Throws:
PortalException
-
getFileShortcuts
-
getFileShortcuts
-
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
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
rebuildTree
- Throws:
PortalException
-
setTreePaths
- Throws:
PortalException
-
updateAsset
public static void updateAsset(long userId, DLFileShortcut fileShortcut, long[] assetCategoryIds, String[] assetTagNames) throws PortalException - Throws:
PortalException
-
updateDLFileShortcut
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
-
setService
-