com.liferay.document.library.kernel.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.

Author:

Brian Wing Shun Chan

See Also:

DLFileVersionLocalServiceUtil, DLFileVersionLocalServiceBaseImpl, DLFileVersionLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
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.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<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.
DLFileVersion	fetchDLFileVersion(long fileVersionId)
DLFileVersion	fetchDLFileVersionByUuidAndGroupId(String uuid, long groupId) Returns the document library file version matching the UUID and group.
DLFileVersion	fetchLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy)
ActionableDynamicQuery	getActionableDynamicQuery()
DLFileVersion	getDLFileVersion(long fileVersionId) Returns the document library file version with the primary key.
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.
List<DLFileVersion>	getDLFileVersionsByUuidAndCompanyId(String uuid, long companyId) Returns all the document library file versions matching the UUID and company.
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.
int	getDLFileVersionsCount() Returns the number of document library file versions.
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
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)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
DLFileVersion	getLatestFileVersion(long fileEntryId, boolean excludeWorkingCopy)
DLFileVersion	getLatestFileVersion(long userId, long fileEntryId)
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
void	rebuildTree(long companyId)
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)

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

createDLFileVersion

@Transactional(enabled=false)
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(DLFileVersion dlFileVersion)

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

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.

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

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

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

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

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 query

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLFileVersion fetchLatestFileVersion(long fileEntryId,
                                                                                                        boolean excludeWorkingCopy)

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

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

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

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

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

getFileVersionsCount

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

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 interface PersistedModelLocalService

Throws:

PortalException

rebuildTree

void rebuildTree(long companyId)
          throws PortalException

Throws:

PortalException

setTreePaths

void setTreePaths(long folderId,
                  String treePath)
           throws PortalException

Throws:

PortalException

updateDLFileVersion

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

Parameters:

dlFileVersion - the document library file version

Returns:

the document library file version that was updated