Class DLFileVersionLocalServiceUtil
com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl 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 DLFileVersionaddDLFileVersion(DLFileVersion dlFileVersion) Adds the document library file version to the database.static DLFileVersioncreateDLFileVersion(long fileVersionId) Creates a new document library file version with the primary key.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static DLFileVersiondeleteDLFileVersion(long fileVersionId) Deletes the document library file version with the primary key from the database.static DLFileVersiondeleteDLFileVersion(DLFileVersion dlFileVersion) Deletes the document library file version from the database.static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <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 longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static DLFileVersionfetchDLFileVersion(long fileVersionId) static DLFileVersionfetchDLFileVersionByUuidAndGroupId(String uuid, long groupId) Returns the document library file version matching the UUID and group.static DLFileVersionfetchLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy) static DLFileVersionfetchLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy, int status) static ActionableDynamicQuerystatic DLFileVersiongetDLFileVersion(long fileVersionId) Returns the document library file version with the primary key.static DLFileVersiongetDLFileVersionByUuidAndGroupId(String uuid, long groupId) Returns the document library file version matching the UUID and group.static List<DLFileVersion>getDLFileVersions(int start, int end) Returns a range of all the document library file versions.static List<DLFileVersion>getDLFileVersionsByUuidAndCompanyId(String uuid, long companyId) Returns all the document library file versions matching the UUID and company.static 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.static intReturns the number of document library file versions.static ExportActionableDynamicQuerygetExportActionableDynamicQuery(PortletDataContext portletDataContext) static DLFileVersiongetFileVersion(long fileVersionId) static DLFileVersiongetFileVersion(long fileEntryId, String version) static DLFileVersiongetFileVersionByUuidAndGroupId(String uuid, long groupId) static List<DLFileVersion>getFileVersions(long fileEntryId, int status) static List<DLFileVersion>getFileVersions(long fileEntryId, int status, int start, int end) static intgetFileVersionsCount(long fileEntryId, int status) static intgetFileVersionsCount(long companyId, String storeUUID) static DLFileVersiongetLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy) static DLFileVersiongetLatestFileVersion(long userId, long fileEntryId) static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static DLFileVersionLocalServicestatic voidrebuildTree(long companyId) static voidsetService(DLFileVersionLocalService service) static voidsetTreePaths(long folderId, String treePath) static DLFileVersionupdateDLFileVersion(DLFileVersion dlFileVersion) Updates the document library file version in the database or adds it if it does not yet exist.
-
Constructor Details
-
DLFileVersionLocalServiceUtil
public DLFileVersionLocalServiceUtil()
-
-
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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - 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
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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - Throws:
PortalException
-
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
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
-
fetchDLFileVersion
-
fetchDLFileVersionByUuidAndGroupId
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
nullif a matching document library file version could not be found
-
fetchLatestFileVersion
-
fetchLatestFileVersion
public static DLFileVersion fetchLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy, int status) -
getActionableDynamicQuery
-
getDLFileVersion
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
public static 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
Returns a range of all the document library file versions.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris 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
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
public static 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
public static int getDLFileVersionsCount()Returns the number of document library file versions.- Returns:
- the number of document library file versions
-
getExportActionableDynamicQuery
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getFileVersion
- Throws:
PortalException
-
getFileVersion
- Throws:
PortalException
-
getFileVersionByUuidAndGroupId
-
getFileVersions
-
getFileVersions
-
getFileVersionsCount
public static int getFileVersionsCount(long fileEntryId, int status) -
getFileVersionsCount
-
getIndexableActionableDynamicQuery
-
getLatestFileVersion
public static DLFileVersion getLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy) throws PortalException - Throws:
PortalException
-
getLatestFileVersion
public static DLFileVersion getLatestFileVersion(long userId, long fileEntryId) throws PortalException - Throws:
PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- 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
-
getService
-
setService
-