com.liferay.document.library.kernel.service

Class DLContentLocalServiceUtil

Object

com.liferay.document.library.kernel.service.DLContentLocalServiceUtil

@ProviderType
public class DLContentLocalServiceUtil
extends Object

Provides the local service utility for DLContent. This utility wraps DLContentLocalServiceImpl 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.

Author:

Brian Wing Shun Chan

See Also:

DLContentLocalService, DLContentLocalServiceBaseImpl, DLContentLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
DLContentLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static DLContent	addContent(long companyId, long repositoryId, String path, String version, byte[] bytes)
static DLContent	addContent(long companyId, long repositoryId, String path, String version, InputStream inputStream, long size)
static DLContent	addDLContent(DLContent dlContent) Adds the document library content to the database.
static DLContent	createDLContent(long contentId) Creates a new document library content with the primary key.
static void	deleteContent(long companyId, long repositoryId, String path, String version)
static void	deleteContents(long companyId, long repositoryId, String path)
static void	deleteContentsByDirectory(long companyId, long repositoryId, String dirName)
static DLContent	deleteDLContent(DLContent dlContent) Deletes the document library content from the database.
static DLContent	deleteDLContent(long contentId) Deletes the document library content with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static DynamicQuery	dynamicQuery()
static <T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <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.
static <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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static DLContent	fetchDLContent(long contentId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static DLContent	getContent(long companyId, long repositoryId, String path)
static DLContent	getContent(long companyId, long repositoryId, String path, String version)
static List<DLContent>	getContents(long companyId, long repositoryId)
static List<DLContent>	getContents(long companyId, long repositoryId, String path)
static List<DLContent>	getContentsByDirectory(long companyId, long repositoryId, String dirName)
static DLContentDataBlobModel	getDataBlobModel(Serializable primaryKey)
static DLContent	getDLContent(long contentId) Returns the document library content with the primary key.
static List<DLContent>	getDLContents(int start, int end) Returns a range of all the document library contents.
static int	getDLContentsCount() Returns the number of document library contents.
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static DLContentLocalService	getService()
static boolean	hasContent(long companyId, long repositoryId, String path, String version)
static DLContent	updateDLContent(DLContent dlContent) Updates the document library content in the database or adds it if it does not yet exist.
static void	updateDLContent(long companyId, long oldRepositoryId, long newRepositoryId, String oldPath, String newPath)

Methods inherited from class Object

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

Constructor Detail

DLContentLocalServiceUtil

public DLContentLocalServiceUtil()

Method Detail

addContent

public static DLContent addContent(long companyId,
                                   long repositoryId,
                                   String path,
                                   String version,
                                   byte[] bytes)

addContent

public static DLContent addContent(long companyId,
                                   long repositoryId,
                                   String path,
                                   String version,
                                   InputStream inputStream,
                                   long size)

addDLContent

public static DLContent addDLContent(DLContent dlContent)

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

Parameters:

dlContent - the document library content

Returns:

the document library content that was added

createDLContent

public static DLContent createDLContent(long contentId)

Creates a new document library content with the primary key. Does not add the document library content to the database.

Parameters:

contentId - the primary key for the new document library content

Returns:

the new document library content

deleteContent

public static void deleteContent(long companyId,
                                 long repositoryId,
                                 String path,
                                 String version)
                          throws PortalException

Throws:

PortalException

deleteContents

public static void deleteContents(long companyId,
                                  long repositoryId,
                                  String path)

deleteContentsByDirectory

public static void deleteContentsByDirectory(long companyId,
                                             long repositoryId,
                                             String dirName)

deleteDLContent

public static DLContent deleteDLContent(DLContent dlContent)

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

Parameters:

dlContent - the document library content

Returns:

the document library content that was removed

deleteDLContent

public static DLContent deleteDLContent(long contentId)
                                 throws PortalException

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

Parameters:

contentId - the primary key of the document library content

Returns:

the document library content that was removed

Throws:

PortalException - if a document library content with the primary key could not be found

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

public static <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 DLContentModelImpl. 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> 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 DLContentModelImpl. 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(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(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

fetchDLContent

public static DLContent fetchDLContent(long contentId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getContent

public static DLContent getContent(long companyId,
                                   long repositoryId,
                                   String path)
                            throws NoSuchContentException

Throws:

NoSuchContentException

getContent

public static DLContent getContent(long companyId,
                                   long repositoryId,
                                   String path,
                                   String version)
                            throws NoSuchContentException

Throws:

NoSuchContentException

getContents

public static List<DLContent> getContents(long companyId,
                                          long repositoryId)

getContents

public static List<DLContent> getContents(long companyId,
                                          long repositoryId,
                                          String path)

getContentsByDirectory

public static List<DLContent> getContentsByDirectory(long companyId,
                                                     long repositoryId,
                                                     String dirName)

getDataBlobModel

public static DLContentDataBlobModel getDataBlobModel(Serializable primaryKey)

getDLContent

public static DLContent getDLContent(long contentId)
                              throws PortalException

Returns the document library content with the primary key.

Parameters:

contentId - the primary key of the document library content

Returns:

the document library content

Throws:

PortalException - if a document library content with the primary key could not be found

getDLContents

public static List<DLContent> getDLContents(int start,
                                            int end)

Returns a range of all the document library contents.

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 DLContentModelImpl. 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 contents

end - the upper bound of the range of document library contents (not inclusive)

Returns:

the range of document library contents

getDLContentsCount

public static int getDLContentsCount()

Returns the number of document library contents.

Returns:

the number of document library contents

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

hasContent

public static boolean hasContent(long companyId,
                                 long repositoryId,
                                 String path,
                                 String version)

updateDLContent

public static DLContent updateDLContent(DLContent dlContent)

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

Parameters:

dlContent - the document library content

Returns:

the document library content that was updated

updateDLContent

public static void updateDLContent(long companyId,
                                   long oldRepositoryId,
                                   long newRepositoryId,
                                   String oldPath,
                                   String newPath)

getService

public static DLContentLocalService getService()