com.liferay.portlet.documentlibrary.service
Interface DLFileVersionLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

DLFileVersionLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface DLFileVersionLocalService
extends BaseLocalService, PersistedModelLocalService

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

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

Method Summary

DLFileVersion	addDLFileVersion(DLFileVersion dlFileVersion) Adds the document library file version to the database.
DLFileVersion	createDLFileVersion(long fileVersionId) Creates a new document library file version with the primary key.
DLFileVersion	deleteDLFileVersion(DLFileVersion dlFileVersion) Deletes the document library file version from the database.
DLFileVersion	deleteDLFileVersion(long fileVersionId) Deletes the document library file version with the primary key from the database.
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
DLFileVersion	fetchDLFileVersion(long fileVersionId)
DLFileVersion	fetchDLFileVersionByUuidAndCompanyId(String uuid, long companyId) Returns the document library file version with the matching UUID and company.
DLFileVersion	fetchDLFileVersionByUuidAndGroupId(String uuid, long groupId) Returns the document library file version matching the UUID and group.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
DLFileVersion	getDLFileVersion(long fileVersionId) Returns the document library file version with the primary key.
DLFileVersion	getDLFileVersionByUuidAndCompanyId(String uuid, long companyId) Returns the document library file version with the matching UUID and company.
DLFileVersion	getDLFileVersionByUuidAndGroupId(String uuid, long groupId) Returns the document library file version matching the UUID and group.
List<DLFileVersion>	getDLFileVersions(int start, int end) Returns a range of all the document library file versions.
int	getDLFileVersionsCount() Returns the number of document library file versions.
DLFileVersion	getFileVersion(long fileVersionId)
DLFileVersion	getFileVersion(long fileEntryId, String version)
DLFileVersion	getFileVersionByUuidAndGroupId(String uuid, long groupId)
List<DLFileVersion>	getFileVersions(long fileEntryId, int status)
int	getFileVersionsCount(long fileEntryId, int status)
DLFileVersion	getLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy)
DLFileVersion	getLatestFileVersion(long userId, long fileEntryId)
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
void	rebuildTree(long companyId)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setTreePaths(long folderId, String treePath)
DLFileVersion	updateDLFileVersion(DLFileVersion dlFileVersion) Updates the document library file version in the database or adds it if it does not yet exist.

Method Detail

addDLFileVersion

@Indexable(type=REINDEX)
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

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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion fetchDLFileVersion(long fileVersionId)
                                 throws SystemException

Throws:

SystemException

fetchDLFileVersionByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getDLFileVersionByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Indexable(type=REINDEX)
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

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

getFileVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion getFileVersion(long fileVersionId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getFileVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion getFileVersion(long fileEntryId,
                                                                      String version)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getFileVersionByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion getFileVersionByUuidAndGroupId(String uuid,
                                                                                      long groupId)
                                             throws SystemException

Throws:

SystemException

getFileVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLFileVersion> getFileVersions(long fileEntryId,
                                                                             int status)
                                    throws SystemException

Throws:

SystemException

getFileVersionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileVersionsCount(long fileEntryId,
                                                                  int status)
                         throws SystemException

Throws:

SystemException

getLatestFileVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion getLatestFileVersion(long fileEntryId,
                                                                            boolean excludeWorkingCopy)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getLatestFileVersion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion getLatestFileVersion(long userId,
                                                                            long fileEntryId)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

rebuildTree

void rebuildTree(long companyId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

setTreePaths

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

Throws:

PortalException

SystemException