com.liferay.document.library.service

Interface FileVersionPreviewLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

FileVersionPreviewLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface FileVersionPreviewLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

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

FileVersionPreviewLocalServiceUtil, com.liferay.document.library.service.base.FileVersionPreviewLocalServiceBaseImpl, com.liferay.document.library.service.impl.FileVersionPreviewLocalServiceImpl

Generated:

Method Summary

Modifier and Type	Method and Description
FileVersionPreview	addFileVersionPreview(FileVersionPreview fileVersionPreview) Adds the file version preview to the database.
void	addFileVersionPreview(long fileEntryId, long fileVersionId, int previewStatus)
FileVersionPreview	createFileVersionPreview(long fileVersionPreviewId) Creates a new file version preview with the primary key.
void	deleteFileEntryFileVersionPreviews(long fileEntryId)
FileVersionPreview	deleteFileVersionPreview(FileVersionPreview fileVersionPreview) Deletes the file version preview from the database.
FileVersionPreview	deleteFileVersionPreview(long fileVersionPreviewId) Deletes the file version preview with the primary key from the database.
com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
FileVersionPreview	fetchFileVersionPreview(long fileVersionPreviewId)
FileVersionPreview	fetchFileVersionPreview(long fileEntryId, long fileVersionId)
FileVersionPreview	fetchFileVersionPreview(long fileEntryId, long fileVersionId, int previewStatus)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
java.util.List<FileVersionPreview>	getFileEntryFileVersionPreviews(long fileEntryId)
FileVersionPreview	getFileVersionPreview(long fileVersionPreviewId) Returns the file version preview with the primary key.
FileVersionPreview	getFileVersionPreview(long fileEntryId, long fileVersionId)
FileVersionPreview	getFileVersionPreview(long fileEntryId, long fileVersionId, int previewStatus)
java.util.List<FileVersionPreview>	getFileVersionPreviews(int start, int end) Returns a range of all the file version previews.
int	getFileVersionPreviewsCount() Returns the number of file version previews.
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
boolean	hasFileVersionPreview(long fileEntryId, long fileVersionId, int previewStatus)
FileVersionPreview	updateFileVersionPreview(FileVersionPreview fileVersionPreview) Updates the file version preview in the database or adds it if it does not yet exist.
void	updateFileVersionPreview(long fileVersionPreviewId, int previewStatus)

Method Detail

addFileVersionPreview

@Indexable(type=REINDEX)
FileVersionPreview addFileVersionPreview(FileVersionPreview fileVersionPreview)

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

Parameters:

fileVersionPreview - the file version preview

Returns:

the file version preview that was added

addFileVersionPreview

void addFileVersionPreview(long fileEntryId,
                           long fileVersionId,
                           int previewStatus)
                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createFileVersionPreview

@Transactional(enabled=false)
FileVersionPreview createFileVersionPreview(long fileVersionPreviewId)

Creates a new file version preview with the primary key. Does not add the file version preview to the database.

Parameters:

fileVersionPreviewId - the primary key for the new file version preview

Returns:

the new file version preview

deleteFileEntryFileVersionPreviews

void deleteFileEntryFileVersionPreviews(long fileEntryId)

deleteFileVersionPreview

@Indexable(type=DELETE)
FileVersionPreview deleteFileVersionPreview(FileVersionPreview fileVersionPreview)

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

Parameters:

fileVersionPreview - the file version preview

Returns:

the file version preview that was removed

deleteFileVersionPreview

@Indexable(type=DELETE)
FileVersionPreview deleteFileVersionPreview(long fileVersionPreviewId)
                                                             throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

fileVersionPreviewId - the primary key of the file version preview

Returns:

the file version preview that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a file version preview with the primary key could not be found

deletePersistedModel

com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 com.liferay.document.library.model.impl.FileVersionPreviewModelImpl. 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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      com.liferay.portal.kernel.util.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 com.liferay.document.library.model.impl.FileVersionPreviewModelImpl. 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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                          com.liferay.portal.kernel.dao.orm.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

fetchFileVersionPreview

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FileVersionPreview fetchFileVersionPreview(long fileVersionPreviewId)

fetchFileVersionPreview

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FileVersionPreview fetchFileVersionPreview(long fileEntryId,
                                                                                                              long fileVersionId)

fetchFileVersionPreview

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FileVersionPreview fetchFileVersionPreview(long fileEntryId,
                                                                                                              long fileVersionId,
                                                                                                              int previewStatus)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getFileEntryFileVersionPreviews

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<FileVersionPreview> getFileEntryFileVersionPreviews(long fileEntryId)

getFileVersionPreview

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FileVersionPreview getFileVersionPreview(long fileVersionPreviewId)
                                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Returns the file version preview with the primary key.

Parameters:

fileVersionPreviewId - the primary key of the file version preview

Returns:

the file version preview

Throws:

com.liferay.portal.kernel.exception.PortalException - if a file version preview with the primary key could not be found

getFileVersionPreview

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FileVersionPreview getFileVersionPreview(long fileEntryId,
                                                                                                            long fileVersionId)
                                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getFileVersionPreview

@Transactional(propagation=SUPPORTS,
               readOnly=true)
FileVersionPreview getFileVersionPreview(long fileEntryId,
                                                                                                            long fileVersionId,
                                                                                                            int previewStatus)
                                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getFileVersionPreviews

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<FileVersionPreview> getFileVersionPreviews(int start,
                                                                                                                             int end)

Returns a range of all the file version previews.

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 com.liferay.document.library.model.impl.FileVersionPreviewModelImpl. 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 file version previews

end - the upper bound of the range of file version previews (not inclusive)

Returns:

the range of file version previews

getFileVersionPreviewsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFileVersionPreviewsCount()

Returns the number of file version previews.

Returns:

the number of file version previews

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

hasFileVersionPreview

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasFileVersionPreview(long fileEntryId,
                                                                                                 long fileVersionId,
                                                                                                 int previewStatus)

updateFileVersionPreview

@Indexable(type=REINDEX)
FileVersionPreview updateFileVersionPreview(FileVersionPreview fileVersionPreview)

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

Parameters:

fileVersionPreview - the file version preview

Returns:

the file version preview that was updated

updateFileVersionPreview

void updateFileVersionPreview(long fileVersionPreviewId,
                              int previewStatus)
                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException