Interface DLFileVersionLocalService
- All Superinterfaces:
BaseLocalService
,CTService<DLFileVersion>
,PersistedModelLocalService
- All Known Implementing Classes:
DLFileVersionLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddDLFileVersion
(DLFileVersion dlFileVersion) Adds the document library file version to the database.createDLFileVersion
(long fileVersionId) Creates a new document library file version with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteDLFileVersion
(long fileVersionId) Deletes the document library file version with the primary key from the database.deleteDLFileVersion
(DLFileVersion dlFileVersion) Deletes the document library file version from the database.deletePersistedModel
(PersistedModel persistedModel) <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.fetchDLFileVersion
(long fileVersionId) fetchDLFileVersionByUuidAndGroupId
(String uuid, long groupId) Returns the document library file version matching the UUID and group.fetchLatestFileVersion
(long fileEntryId, boolean excludeWorkingCopy) fetchLatestFileVersion
(long fileEntryId, boolean excludeWorkingCopy, int status) getDLFileVersion
(long fileVersionId) Returns the document library file version with the primary key.getDLFileVersionByUuidAndGroupId
(String uuid, long groupId) Returns the document library file version matching the UUID and group.getDLFileVersions
(int start, int end) Returns a range of all the document library file versions.getDLFileVersionsByUuidAndCompanyId
(String uuid, long companyId) Returns all the document library file versions matching the UUID and company.getDLFileVersionsByUuidAndCompanyId
(String uuid, long companyId, int start, int end, OrderByComparator<DLFileVersion> orderByComparator) Returns a range of document library file versions matching the UUID and company.int
Returns the number of document library file versions.getExportActionableDynamicQuery
(PortletDataContext portletDataContext) getFileVersion
(long fileVersionId) getFileVersion
(long fileEntryId, String version) getFileVersionByUuidAndGroupId
(String uuid, long groupId) getFileVersions
(long fileEntryId, int status) getFileVersions
(long fileEntryId, int status, int start, int end) int
getFileVersionsCount
(long fileEntryId, int status) int
getFileVersionsCount
(long companyId, String storeUUID) getLatestFileVersion
(long fileEntryId, boolean excludeWorkingCopy) getLatestFileVersion
(long userId, long fileEntryId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) void
rebuildTree
(long companyId) void
setTreePaths
(long folderId, String treePath) updateDLFileVersion
(DLFileVersion dlFileVersion) Updates the document library file version in the database or adds it if it does not yet exist.<R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileVersion>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addDLFileVersion
Adds the document library file version to the database. Also notifies the appropriate model listeners.Important: Inspect DLFileVersionLocalServiceImpl 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:
dlFileVersion
- the document library file version- Returns:
- the document library file version that was added
-
createDLFileVersion
Creates a new document library file version with the primary key. Does not add the document library file version to the database.- Parameters:
fileVersionId
- the primary key for the new document library file version- Returns:
- the new document library file version
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deleteDLFileVersion
Deletes the document library file version from the database. Also notifies the appropriate model listeners.Important: Inspect DLFileVersionLocalServiceImpl 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:
dlFileVersion
- the document library file version- Returns:
- the document library file version that was removed
-
deleteDLFileVersion
@Indexable(type=DELETE) DLFileVersion deleteDLFileVersion(long fileVersionId) throws PortalException Deletes the document library file version with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect DLFileVersionLocalServiceImpl 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:
fileVersionId
- the primary key of the document library file version- Returns:
- the document library file version that was removed
- Throws:
PortalException
- if a document library file version with the primary key could not be found
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
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.DLFileVersionModelImpl
.- 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.DLFileVersionModelImpl
.- 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
-
fetchDLFileVersion
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion fetchDLFileVersion(long fileVersionId) -
fetchDLFileVersionByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion fetchDLFileVersionByUuidAndGroupId(String uuid, long groupId) Returns the document library file version matching the UUID and group.- Parameters:
uuid
- the document library file version's UUIDgroupId
- the primary key of the group- Returns:
- the matching document library file version, or
null
if a matching document library file version could not be found
-
fetchLatestFileVersion
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion fetchLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy) -
fetchLatestFileVersion
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion fetchLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy, int status) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getDLFileVersion
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion getDLFileVersion(long fileVersionId) throws PortalException Returns the document library file version with the primary key.- Parameters:
fileVersionId
- the primary key of the document library file version- Returns:
- the document library file version
- Throws:
PortalException
- if a document library file version with the primary key could not be found
-
getDLFileVersionByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion getDLFileVersionByUuidAndGroupId(String uuid, long groupId) throws PortalException Returns the document library file version matching the UUID and group.- Parameters:
uuid
- the document library file version's UUIDgroupId
- the primary key of the group- Returns:
- the matching document library file version
- Throws:
PortalException
- if a matching document library file version could not be found
-
getDLFileVersions
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileVersion> getDLFileVersions(int start, int end) Returns a range of all the document library file versions.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.DLFileVersionModelImpl
.- Parameters:
start
- the lower bound of the range of document library file versionsend
- the upper bound of the range of document library file versions (not inclusive)- Returns:
- the range of document library file versions
-
getDLFileVersionsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileVersion> getDLFileVersionsByUuidAndCompanyId(String uuid, long companyId) Returns all the document library file versions matching the UUID and company.- Parameters:
uuid
- the UUID of the document library file versionscompanyId
- the primary key of the company- Returns:
- the matching document library file versions, or an empty list if no matches were found
-
getDLFileVersionsByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileVersion> getDLFileVersionsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<DLFileVersion> orderByComparator) Returns a range of document library file versions matching the UUID and company.- Parameters:
uuid
- the UUID of the document library file versionscompanyId
- the primary key of the companystart
- the lower bound of the range of document library file versionsend
- the upper bound of the range of document library file versions (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- Returns:
- the range of matching document library file versions, or an empty list if no matches were found
-
getDLFileVersionsCount
Returns the number of document library file versions.- Returns:
- the number of document library file versions
-
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getFileVersion
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion getFileVersion(long fileVersionId) throws PortalException - Throws:
PortalException
-
getFileVersion
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion getFileVersion(long fileEntryId, String version) throws PortalException - Throws:
PortalException
-
getFileVersionByUuidAndGroupId
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion getFileVersionByUuidAndGroupId(String uuid, long groupId) -
getFileVersions
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileVersion> getFileVersions(long fileEntryId, int status) -
getFileVersions
@Transactional(propagation=SUPPORTS, readOnly=true) List<DLFileVersion> getFileVersions(long fileEntryId, int status, int start, int end) -
getFileVersionsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileVersionsCount(long fileEntryId, int status) -
getFileVersionsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getFileVersionsCount(long companyId, String storeUUID) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getLatestFileVersion
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion getLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy) throws PortalException - Throws:
PortalException
-
getLatestFileVersion
@Transactional(propagation=SUPPORTS, readOnly=true) DLFileVersion getLatestFileVersion(long userId, long fileEntryId) throws PortalException - Throws:
PortalException
-
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
-
updateDLFileVersion
Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect DLFileVersionLocalServiceImpl 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:
dlFileVersion
- the document library file version- Returns:
- the document library file version that was updated
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<DLFileVersion>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<DLFileVersion>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<DLFileVersion>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<DLFileVersion>
- Throws:
E extends Throwable
-