com.liferay.document.library.kernel.service

Interface DLContentLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

DLContentLocalServiceWrapper

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

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

DLContentLocalServiceUtil, DLContentLocalServiceBaseImpl, DLContentLocalServiceImpl

{$generated.description}

Method Summary

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

Method Detail

addContent

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

addContent

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

addDLContent

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

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

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

Throws:

PortalException

deleteContents

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

deleteContentsByDirectory

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

deleteDLContent

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

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

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

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

@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

fetchDLContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLContent fetchDLContent(long contentId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLContent getContent(long companyId,
                                                                                        long repositoryId,
                                                                                        String path)
                                                                                 throws NoSuchContentException

Throws:

NoSuchContentException

getContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLContent getContent(long companyId,
                                                                                        long repositoryId,
                                                                                        String path,
                                                                                        String version)
                                                                                 throws NoSuchContentException

Throws:

NoSuchContentException

getContents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLContent> getContents(long companyId,
                                                                                               long repositoryId)

getContents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLContent> getContents(long companyId,
                                                                                               long repositoryId,
                                                                                               String path)

getContentsByDirectory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLContent> getContentsByDirectory(long companyId,
                                                                                                          long repositoryId,
                                                                                                          String dirName)

getDataBlobModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLContentDataBlobModel getDataBlobModel(Serializable primaryKey)

getDLContent

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

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

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

Returns the number of document library contents.

Returns:

the number of document library contents

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

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

hasContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasContent(long companyId,
                                                                                      long repositoryId,
                                                                                      String path,
                                                                                      String version)

updateDLContent

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

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