com.liferay.document.library.service

Class FileVersionPreviewLocalServiceUtil

java.lang.Object

com.liferay.document.library.service.FileVersionPreviewLocalServiceUtil

public class FileVersionPreviewLocalServiceUtil
extends java.lang.Object

Provides the local service utility for FileVersionPreview. This utility wraps com.liferay.document.library.service.impl.FileVersionPreviewLocalServiceImpl 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:

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

Generated:

Constructor Summary

Constructors

Constructor and Description
FileVersionPreviewLocalServiceUtil()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FileVersionPreviewLocalServiceUtil

public FileVersionPreviewLocalServiceUtil()

Method Detail

addFileVersionPreview

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

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

Throws:

com.liferay.portal.kernel.exception.PortalException

createFileVersionPreview

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

public static void deleteFileEntryFileVersionPreviews(long fileEntryId)

deleteFileVersionPreview

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

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

PortalException - if a file version preview with the primary key could not be found

deletePersistedModel

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

Throws:

PortalException

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static FileVersionPreview fetchFileVersionPreview(long fileVersionPreviewId)

fetchFileVersionPreview

public static FileVersionPreview fetchFileVersionPreview(long fileEntryId,
                                                         long fileVersionId)

fetchFileVersionPreview

public static FileVersionPreview fetchFileVersionPreview(long fileEntryId,
                                                         long fileVersionId,
                                                         int previewStatus)

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getFileEntryFileVersionPreviews

public static java.util.List<FileVersionPreview> getFileEntryFileVersionPreviews(long fileEntryId)

getFileVersionPreview

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

PortalException - if a file version preview with the primary key could not be found

getFileVersionPreview

public static FileVersionPreview getFileVersionPreview(long fileEntryId,
                                                       long fileVersionId)
                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getFileVersionPreview

public static FileVersionPreview getFileVersionPreview(long fileEntryId,
                                                       long fileVersionId,
                                                       int previewStatus)
                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getFileVersionPreviews

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

public static int getFileVersionPreviewsCount()

Returns the number of file version previews.

Returns:

the number of file version previews

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

hasFileVersionPreview

public static boolean hasFileVersionPreview(long fileEntryId,
                                            long fileVersionId,
                                            int previewStatus)

updateFileVersionPreview

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

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

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static FileVersionPreviewLocalService getService()