com.liferay.portlet.documentlibrary.service
Interface DLContentLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

DLContentLocalServiceWrapper

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

The interface for the document library content local service.

This is a local service. 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:

DLContentLocalServiceUtil, com.liferay.portlet.documentlibrary.service.base.DLContentLocalServiceBaseImpl, com.liferay.portlet.documentlibrary.service.impl.DLContentLocalServiceImpl

Method Summary

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.
DynamicQuery	dynamicQuery()
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
DLContent	fetchDLContent(long contentId)
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
boolean	hasContent(long companyId, long repositoryId, String path, String version)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
DLContent	updateDLContent(DLContent dlContent) Updates the document library content in the database or adds it if it does not yet exist.
DLContent	updateDLContent(DLContent dlContent, boolean merge) 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

addDLContent

DLContent addDLContent(DLContent dlContent)
                       throws SystemException

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

Throws:

SystemException - if a system exception occurred

createDLContent

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

deleteDLContent

DLContent deleteDLContent(long contentId)
                          throws PortalException,
                                 SystemException

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

SystemException - if a system exception occurred

deleteDLContent

DLContent deleteDLContent(DLContent dlContent)
                          throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchDLContent

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

Throws:

SystemException

getDLContent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DLContent getDLContent(long contentId)
                       throws PortalException,
                              SystemException

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

SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getDLContents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<DLContent> getDLContents(int start,
                                                                       int end)
                              throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

getDLContentsCount

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

Returns the number of document library contents.

Returns:

the number of document library contents

Throws:

SystemException - if a system exception occurred

updateDLContent

DLContent updateDLContent(DLContent dlContent)
                          throws SystemException

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

Throws:

SystemException - if a system exception occurred

updateDLContent

DLContent updateDLContent(DLContent dlContent,
                          boolean merge)
                          throws SystemException

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

merge - whether to merge the document library content with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the document library content that was updated

Throws:

SystemException - if a system exception occurred

getDataBlobModel

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

Throws:

SystemException

getBeanIdentifier

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addContent

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

Throws:

SystemException

addContent

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

Throws:

SystemException

deleteContent

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

Throws:

PortalException

SystemException

deleteContents

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

Throws:

SystemException

deleteContentsByDirectory

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

Throws:

SystemException

getContent

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

Throws:

SystemException

NoSuchContentException

getContent

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

Throws:

SystemException

NoSuchContentException

getContents

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

Throws:

SystemException

getContents

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

Throws:

SystemException

getContentsByDirectory

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

Throws:

SystemException

hasContent

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

Throws:

SystemException

updateDLContent

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

Throws:

SystemException