com.liferay.document.library.kernel.service

Class DLFileVersionLocalServiceUtil

Object

com.liferay.document.library.kernel.service.DLFileVersionLocalServiceUtil

public class DLFileVersionLocalServiceUtil
extends Object

Provides the local service utility for DLFileVersion. This utility wraps 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:

DLFileVersionLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLFileVersionLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DLFileVersion	addDLFileVersion(DLFileVersion dlFileVersion) Adds the document library file version to the database.
static DLFileVersion	createDLFileVersion(long fileVersionId) Creates a new document library file version with the primary key.
static PersistedModel	createPersistedModel(Serializable primaryKeyObj)
static DLFileVersion	deleteDLFileVersion(DLFileVersion dlFileVersion) Deletes the document library file version from the database.
static DLFileVersion	deleteDLFileVersion(long fileVersionId) Deletes the document library file version with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static DynamicQuery	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 DLFileVersion	fetchDLFileVersion(long fileVersionId)
static DLFileVersion	fetchDLFileVersionByUuidAndGroupId(String uuid, long groupId) Returns the document library file version matching the UUID and group.
static DLFileVersion	fetchLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy)
static ActionableDynamicQuery	getActionableDynamicQuery()
static DLFileVersion	getDLFileVersion(long fileVersionId) Returns the document library file version with the primary key.
static DLFileVersion	getDLFileVersionByUuidAndGroupId(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 int	getDLFileVersionsCount() Returns the number of document library file versions.
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static DLFileVersion	getFileVersion(long fileVersionId)
static DLFileVersion	getFileVersion(long fileEntryId, String version)
static DLFileVersion	getFileVersionByUuidAndGroupId(String uuid, long groupId)
static List<DLFileVersion>	getFileVersions(long fileEntryId, int status)
static int	getFileVersionsCount(long fileEntryId, int status)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static DLFileVersion	getLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy)
static DLFileVersion	getLatestFileVersion(long userId, long fileEntryId)
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static DLFileVersionLocalService	getService()
static void	rebuildTree(long companyId)
static void	setTreePaths(long folderId, String treePath)
static DLFileVersion	updateDLFileVersion(DLFileVersion dlFileVersion) Updates the document library file version in the database or adds it if it does not yet exist.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DLFileVersionLocalServiceUtil

public DLFileVersionLocalServiceUtil()

Method Detail

addDLFileVersion

public static DLFileVersion addDLFileVersion(DLFileVersion dlFileVersion)

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

public static DLFileVersion createDLFileVersion(long fileVersionId)

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

public static DLFileVersion deleteDLFileVersion(DLFileVersion dlFileVersion)

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

public static 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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(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.DLFileVersionModelImpl.

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.DLFileVersionModelImpl.

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

fetchDLFileVersion

public static DLFileVersion fetchDLFileVersion(long fileVersionId)

fetchDLFileVersionByUuidAndGroupId

public static 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 UUID

groupId - 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

public static DLFileVersion fetchLatestFileVersion(long fileEntryId,
                                                   boolean excludeWorkingCopy)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDLFileVersion

public static 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

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 UUID

groupId - 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

public static 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 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.DLFileVersionModelImpl.

Parameters:

start - the lower bound of the range of document library file versions

end - the upper bound of the range of document library file versions (not inclusive)

Returns:

the range of document library file versions

getDLFileVersionsByUuidAndCompanyId

public static 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 versions

companyId - 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 versions

companyId - the primary key of the company

start - the lower bound of the range of document library file versions

end - the upper bound of the range of document library file versions (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

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

public static DLFileVersion getFileVersion(long fileVersionId)
                                    throws PortalException

Throws:

PortalException

getFileVersion

public static DLFileVersion getFileVersion(long fileEntryId,
                                           String version)
                                    throws PortalException

Throws:

PortalException

getFileVersionByUuidAndGroupId

public static DLFileVersion getFileVersionByUuidAndGroupId(String uuid,
                                                           long groupId)

getFileVersions

public static List<DLFileVersion> getFileVersions(long fileEntryId,
                                                  int status)

getFileVersionsCount

public static int getFileVersionsCount(long fileEntryId,
                                       int status)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery 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

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

updateDLFileVersion

public static DLFileVersion updateDLFileVersion(DLFileVersion dlFileVersion)

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

public static DLFileVersionLocalService getService()