Interface DLFileShortcutLocalService
- All Superinterfaces:
BaseLocalService
,CTService<DLFileShortcut>
,PersistedModelLocalService
- All Known Implementing Classes:
DLFileShortcutLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddDLFileShortcut
(DLFileShortcut dlFileShortcut) Adds the document library file shortcut to the database.addFileShortcut
(String externalReferenceCode, long userId, long groupId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) void
addFileShortcutResources
(long fileShortcutId, boolean addGroupPermissions, boolean addGuestPermissions) void
addFileShortcutResources
(long fileShortcutId, ModelPermissions modelPermissions) void
addFileShortcutResources
(DLFileShortcut fileShortcut, boolean addGroupPermissions, boolean addGuestPermissions) void
addFileShortcutResources
(DLFileShortcut fileShortcut, ModelPermissions modelPermissions) createDLFileShortcut
(long fileShortcutId) Creates a new document library file shortcut with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteDLFileShortcut
(long fileShortcutId) Deletes the document library file shortcut with the primary key from the database.deleteDLFileShortcut
(DLFileShortcut dlFileShortcut) Deletes the document library file shortcut from the database.void
deleteFileShortcut
(long fileShortcutId) void
deleteFileShortcut
(DLFileShortcut fileShortcut) void
deleteFileShortcut
(String externalReferenceCode, long groupId) void
deleteFileShortcuts
(long toFileEntryId) void
deleteFileShortcuts
(long groupId, long folderId) void
deleteFileShortcuts
(long groupId, long folderId, boolean includeTrashedEntries) deletePersistedModel
(PersistedModel persistedModel) void
deleteRepositoryFileShortcuts
(long repositoryId) void
disableFileShortcuts
(long toFileEntryId) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.void
enableFileShortcuts
(long toFileEntryId) fetchDLFileShortcut
(long fileShortcutId) fetchDLFileShortcutByExternalReferenceCode
(String externalReferenceCode, long groupId) fetchDLFileShortcutByUuidAndGroupId
(String uuid, long groupId) Returns the document library file shortcut matching the UUID and group.getDLFileShortcut
(long fileShortcutId) Returns the document library file shortcut with the primary key.getDLFileShortcutByExternalReferenceCode
(String externalReferenceCode, long groupId) getDLFileShortcutByUuidAndGroupId
(String uuid, long groupId) Returns the document library file shortcut matching the UUID and group.getDLFileShortcuts
(int start, int end) Returns a range of all the document library file shortcuts.getDLFileShortcutsByUuidAndCompanyId
(String uuid, long companyId) Returns all the document library file shortcuts matching the UUID and company.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.int
Returns the number of document library file shortcuts.getExportActionableDynamicQuery
(PortletDataContext portletDataContext) getFileShortcut
(long fileShortcutId) getFileShortcuts
(long toFileEntryId) getFileShortcuts
(long groupId, long folderId) getFileShortcuts
(long groupId, long folderId, boolean active, int status, int start, int end) int
getFileShortcutsCount
(long groupId, long folderId, boolean active, int status) getGroupFileShortcuts
(long groupId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) void
rebuildTree
(long companyId) void
setTreePaths
(long folderId, String treePath) void
updateAsset
(long userId, DLFileShortcut fileShortcut, long[] assetCategoryIds, String[] assetTagNames) updateDLFileShortcut
(DLFileShortcut dlFileShortcut) Updates the document library file shortcut in the database or adds it if it does not yet exist.updateFileShortcut
(long userId, long fileShortcutId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) void
updateFileShortcuts
(long oldToFileEntryId, long newToFileEntryId) void
updateFileShortcutsActive
(long toFileEntryId, boolean active) updateStatus
(long userId, long fileShortcutId, int status, ServiceContext serviceContext) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileShortcut>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
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
DLFileShortcut addFileShortcut(String externalReferenceCode, long userId, long groupId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addFileShortcutResources
void addFileShortcutResources(DLFileShortcut fileShortcut, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException - Throws:
PortalException
-
addFileShortcutResources
void addFileShortcutResources(DLFileShortcut fileShortcut, ModelPermissions modelPermissions) throws PortalException - Throws:
PortalException
-
addFileShortcutResources
void addFileShortcutResources(long fileShortcutId, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException - Throws:
PortalException
-
addFileShortcutResources
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
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- 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
@Indexable(type=DELETE) 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
- Throws:
PortalException
-
deleteFileShortcut
- Throws:
PortalException
-
deleteFileShortcut
- Throws:
PortalException
-
deleteFileShortcuts
- Throws:
PortalException
-
deleteFileShortcuts
- Throws:
PortalException
-
deleteFileShortcuts
void deleteFileShortcuts(long groupId, long folderId, boolean includeTrashedEntries) throws PortalException - Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteRepositoryFileShortcuts
- Throws:
PortalException
-
disableFileShortcuts
void disableFileShortcuts(long toFileEntryId) -
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) 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
void enableFileShortcuts(long toFileEntryId) -
fetchDLFileShortcut
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileShortcut fetchDLFileShortcut(long fileShortcutId) -
fetchDLFileShortcutByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileShortcut fetchDLFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) -
fetchDLFileShortcutByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) 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 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
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getDLFileShortcut
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileShortcut getDLFileShortcutByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getDLFileShortcutByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
Returns the number of document library file shortcuts.- Returns:
- the number of document library file shortcuts
-
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getFileShortcut
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileShortcut getFileShortcut(long fileShortcutId) throws PortalException - Throws:
PortalException
-
getFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileShortcut> getFileShortcuts(long toFileEntryId) -
getFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileShortcut> getFileShortcuts(long groupId, long folderId) -
getFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileShortcut> getFileShortcuts(long groupId, long folderId, boolean active, int status, int start, int end) -
getFileShortcutsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileShortcutsCount(long groupId, long folderId, boolean active, int status) -
getGroupFileShortcuts
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileShortcut> getGroupFileShortcuts(long groupId) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
rebuildTree
- Throws:
PortalException
-
setTreePaths
- Throws:
PortalException
-
updateAsset
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
DLFileShortcut updateFileShortcut(long userId, long fileShortcutId, long repositoryId, long folderId, long toFileEntryId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
updateFileShortcuts
void updateFileShortcuts(long oldToFileEntryId, long newToFileEntryId) -
updateFileShortcutsActive
void updateFileShortcutsActive(long toFileEntryId, boolean active) -
updateStatus
DLFileShortcut updateStatus(long userId, long fileShortcutId, int status, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<DLFileShortcut>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<DLFileShortcut>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileShortcut>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<DLFileShortcut>
- Throws:
E extends Throwable
-