com.liferay.portlet.documentlibrary.service
Class DLFileVersionLocalServiceUtil

java.lang.Object
  com.liferay.portlet.documentlibrary.service.DLFileVersionLocalServiceUtil

@ProviderType
public class DLFileVersionLocalServiceUtil
extends Object

Provides the local service utility for DLFileVersion. This utility wraps com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl and is the primary 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.

See Also:

DLFileVersionLocalService, com.liferay.portlet.documentlibrary.service.base.DLFileVersionLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLFileVersionLocalServiceImpl

Constructor Summary

DLFileVersionLocalServiceUtil()

Method Summary

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 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 DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static DLFileVersion	fetchDLFileVersion(long fileVersionId)
static DLFileVersion	fetchDLFileVersionByUuidAndCompanyId(String uuid, long companyId) Returns the document library file version with the matching UUID and company.
static DLFileVersion	fetchDLFileVersionByUuidAndGroupId(String uuid, long groupId) Returns the document library file version matching the UUID and group.
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static DLFileVersion	getDLFileVersion(long fileVersionId) Returns the document library file version with the primary key.
static DLFileVersion	getDLFileVersionByUuidAndCompanyId(String uuid, long companyId) Returns the document library file version with the matching UUID and company.
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 int	getDLFileVersionsCount() Returns the number of document library file versions.
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 DLFileVersion	getLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy)
static DLFileVersion	getLatestFileVersion(long userId, long fileEntryId)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static DLFileVersionLocalService	getService()
static void	rebuildTree(long companyId)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(DLFileVersionLocalService service) Deprecated. As of 6.2.0
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 java.lang.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)
                                      throws SystemException

Adds the document library file version to the database. Also notifies the appropriate model listeners.

Parameters:

dlFileVersion - the document library file version

Returns:

the document library file version that was added

Throws:

SystemException - if a system exception occurred

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

deleteDLFileVersion

public static DLFileVersion deleteDLFileVersion(long fileVersionId)
                                         throws PortalException,
                                                SystemException

Deletes the document library file version with the primary key from the database. Also notifies the appropriate model listeners.

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

SystemException - if a system exception occurred

deleteDLFileVersion

public static DLFileVersion deleteDLFileVersion(DLFileVersion dlFileVersion)
                                         throws SystemException

Deletes the document library file version from the database. Also notifies the appropriate model listeners.

Parameters:

dlFileVersion - the document library file version

Returns:

the document library file version that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFileVersionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFileVersionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchDLFileVersion

public static DLFileVersion fetchDLFileVersion(long fileVersionId)
                                        throws SystemException

Throws:

SystemException

fetchDLFileVersionByUuidAndCompanyId

public static DLFileVersion fetchDLFileVersionByUuidAndCompanyId(String uuid,
                                                                 long companyId)
                                                          throws SystemException

Returns the document library file version with the matching UUID and company.

Parameters:

uuid - the document library file version's UUID

companyId - the primary key of the company

Returns:

the matching document library file version, or null if a matching document library file version could not be found

Throws:

SystemException - if a system exception occurred

fetchDLFileVersionByUuidAndGroupId

public static DLFileVersion fetchDLFileVersionByUuidAndGroupId(String uuid,
                                                               long groupId)
                                                        throws SystemException

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

Throws:

SystemException - if a system exception occurred

getDLFileVersion

public static DLFileVersion getDLFileVersion(long fileVersionId)
                                      throws PortalException,
                                             SystemException

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getDLFileVersionByUuidAndCompanyId

public static DLFileVersion getDLFileVersionByUuidAndCompanyId(String uuid,
                                                               long companyId)
                                                        throws PortalException,
                                                               SystemException

Returns the document library file version with the matching UUID and company.

Parameters:

uuid - the document library file version's UUID

companyId - the primary key of the company

Returns:

the matching document library file version

Throws:

PortalException - if a matching document library file version could not be found

SystemException - if a system exception occurred

getDLFileVersionByUuidAndGroupId

public static DLFileVersion getDLFileVersionByUuidAndGroupId(String uuid,
                                                             long groupId)
                                                      throws PortalException,
                                                             SystemException

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

SystemException - if a system exception occurred

getDLFileVersions

public static List<DLFileVersion> getDLFileVersions(int start,
                                                    int end)
                                             throws SystemException

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from DLFileVersionModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

Throws:

SystemException - if a system exception occurred

getDLFileVersionsCount

public static int getDLFileVersionsCount()
                                  throws SystemException

Returns the number of document library file versions.

Returns:

the number of document library file versions

Throws:

SystemException - if a system exception occurred

updateDLFileVersion

public static DLFileVersion updateDLFileVersion(DLFileVersion dlFileVersion)
                                         throws SystemException

Updates the document library file version in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

dlFileVersion - the document library file version

Returns:

the document library file version that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

getFileVersion

public static DLFileVersion getFileVersion(long fileVersionId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getFileVersion

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

Throws:

PortalException

SystemException

getFileVersionByUuidAndGroupId

public static DLFileVersion getFileVersionByUuidAndGroupId(String uuid,
                                                           long groupId)
                                                    throws SystemException

Throws:

SystemException

getFileVersions

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

Throws:

SystemException

getFileVersionsCount

public static int getFileVersionsCount(long fileEntryId,
                                       int status)
                                throws SystemException

Throws:

SystemException

getLatestFileVersion

public static DLFileVersion getLatestFileVersion(long fileEntryId,
                                                 boolean excludeWorkingCopy)
                                          throws PortalException,
                                                 SystemException

Throws:

PortalException

SystemException

getLatestFileVersion

public static DLFileVersion getLatestFileVersion(long userId,
                                                 long fileEntryId)
                                          throws PortalException,
                                                 SystemException

Throws:

PortalException

SystemException

rebuildTree

public static void rebuildTree(long companyId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

setTreePaths

public static void setTreePaths(long folderId,
                                String treePath)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

getService

public static DLFileVersionLocalService getService()

setService

public void setService(DLFileVersionLocalService service)

Deprecated. As of 6.2.0