com.liferay.portlet.journal.service
Interface JournalFolderLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

JournalFolderLocalServiceWrapper

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

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

JournalFolderLocalServiceUtil, com.liferay.portlet.journal.service.base.JournalFolderLocalServiceBaseImpl, com.liferay.portlet.journal.service.impl.JournalFolderLocalServiceImpl

Method Summary

JournalFolder	addFolder(long userId, long groupId, long parentFolderId, String name, String description, ServiceContext serviceContext)
JournalFolder	addJournalFolder(JournalFolder journalFolder) Adds the journal folder to the database.
JournalFolder	createJournalFolder(long folderId) Creates a new journal folder with the primary key.
JournalFolder	deleteFolder(JournalFolder folder)
JournalFolder	deleteFolder(JournalFolder folder, boolean includeTrashedEntries)
JournalFolder	deleteFolder(long folderId)
JournalFolder	deleteFolder(long folderId, boolean includeTrashedEntries)
void	deleteFolders(long groupId)
JournalFolder	deleteJournalFolder(JournalFolder journalFolder) Deletes the journal folder from the database.
JournalFolder	deleteJournalFolder(long folderId) Deletes the journal folder 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.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
JournalFolder	fetchFolder(long folderId)
JournalFolder	fetchFolder(long groupId, long parentFolderId, String name)
JournalFolder	fetchFolder(long groupId, String name)
JournalFolder	fetchJournalFolder(long folderId)
JournalFolder	fetchJournalFolderByUuidAndCompanyId(String uuid, long companyId) Returns the journal folder with the matching UUID and company.
JournalFolder	fetchJournalFolderByUuidAndGroupId(String uuid, long groupId) Returns the journal folder matching the UUID and group.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
List<JournalFolder>	getCompanyFolders(long companyId, int start, int end)
int	getCompanyFoldersCount(long companyId)
JournalFolder	getFolder(long folderId)
List<JournalFolder>	getFolders(long groupId)
List<JournalFolder>	getFolders(long groupId, long parentFolderId)
List<JournalFolder>	getFolders(long groupId, long parentFolderId, int status)
List<JournalFolder>	getFolders(long groupId, long parentFolderId, int start, int end)
List<JournalFolder>	getFolders(long groupId, long parentFolderId, int status, int start, int end)
List<Object>	getFoldersAndArticles(long groupId, long folderId)
List<Object>	getFoldersAndArticles(long groupId, long folderId, int status)
List<Object>	getFoldersAndArticles(long groupId, long folderId, int start, int end, OrderByComparator obc)
int	getFoldersAndArticlesCount(long groupId, List<Long> folderIds, int status)
int	getFoldersAndArticlesCount(long groupId, long folderId)
int	getFoldersAndArticlesCount(long groupId, long folderId, int status)
int	getFoldersCount(long groupId, long parentFolderId)
int	getFoldersCount(long groupId, long parentFolderId, int status)
JournalFolder	getJournalFolder(long folderId) Returns the journal folder with the primary key.
JournalFolder	getJournalFolderByUuidAndCompanyId(String uuid, long companyId) Returns the journal folder with the matching UUID and company.
JournalFolder	getJournalFolderByUuidAndGroupId(String uuid, long groupId) Returns the journal folder matching the UUID and group.
List<JournalFolder>	getJournalFolders(int start, int end) Returns a range of all the journal folders.
int	getJournalFoldersCount() Returns the number of journal folders.
List<JournalFolder>	getNoAssetFolders()
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
void	getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
JournalFolder	moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)
JournalFolder	moveFolderFromTrash(long userId, long folderId, long parentFolderId, ServiceContext serviceContext)
JournalFolder	moveFolderToTrash(long userId, long folderId)
void	rebuildTree(long companyId)
void	rebuildTree(long companyId, long parentFolderId, String parentTreePath, boolean reindex)
void	restoreFolderFromTrash(long userId, long folderId)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	updateAsset(long userId, JournalFolder folder, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds)
JournalFolder	updateFolder(long userId, long folderId, long parentFolderId, String name, String description, boolean mergeWithParentFolder, ServiceContext serviceContext)
JournalFolder	updateJournalFolder(JournalFolder journalFolder) Updates the journal folder in the database or adds it if it does not yet exist.
JournalFolder	updateStatus(long userId, JournalFolder folder, int status)

Method Detail

addJournalFolder

@Indexable(type=REINDEX)
JournalFolder addJournalFolder(JournalFolder journalFolder)
                               throws SystemException

Adds the journal folder to the database. Also notifies the appropriate model listeners.

Parameters:

journalFolder - the journal folder

Returns:

the journal folder that was added

Throws:

SystemException - if a system exception occurred

createJournalFolder

JournalFolder createJournalFolder(long folderId)

Creates a new journal folder with the primary key. Does not add the journal folder to the database.

Parameters:

folderId - the primary key for the new journal folder

Returns:

the new journal folder

deleteJournalFolder

@Indexable(type=DELETE)
JournalFolder deleteJournalFolder(long folderId)
                                  throws PortalException,
                                         SystemException

Deletes the journal folder with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

folderId - the primary key of the journal folder

Returns:

the journal folder that was removed

Throws:

PortalException - if a journal folder with the primary key could not be found

SystemException - if a system exception occurred

deleteJournalFolder

@Indexable(type=DELETE)
JournalFolder deleteJournalFolder(JournalFolder journalFolder)
                                  throws SystemException

Deletes the journal folder from the database. Also notifies the appropriate model listeners.

Parameters:

journalFolder - the journal folder

Returns:

the journal folder 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. 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 JournalFolderModelImpl. 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

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

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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchJournalFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder fetchJournalFolder(long folderId)
                                 throws SystemException

Throws:

SystemException

fetchJournalFolderByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder fetchJournalFolderByUuidAndCompanyId(String uuid,
                                                                                            long companyId)
                                                   throws SystemException

Returns the journal folder with the matching UUID and company.

Parameters:

uuid - the journal folder's UUID

companyId - the primary key of the company

Returns:

the matching journal folder, or null if a matching journal folder could not be found

Throws:

SystemException - if a system exception occurred

fetchJournalFolderByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder fetchJournalFolderByUuidAndGroupId(String uuid,
                                                                                          long groupId)
                                                 throws SystemException

Returns the journal folder matching the UUID and group.

Parameters:

uuid - the journal folder's UUID

groupId - the primary key of the group

Returns:

the matching journal folder, or null if a matching journal folder could not be found

Throws:

SystemException - if a system exception occurred

getJournalFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder getJournalFolder(long folderId)
                               throws PortalException,
                                      SystemException

Returns the journal folder with the primary key.

Parameters:

folderId - the primary key of the journal folder

Returns:

the journal folder

Throws:

PortalException - if a journal folder 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

getJournalFolderByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder getJournalFolderByUuidAndCompanyId(String uuid,
                                                                                          long companyId)
                                                 throws PortalException,
                                                        SystemException

Returns the journal folder with the matching UUID and company.

Parameters:

uuid - the journal folder's UUID

companyId - the primary key of the company

Returns:

the matching journal folder

Throws:

PortalException - if a matching journal folder could not be found

SystemException - if a system exception occurred

getJournalFolderByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder getJournalFolderByUuidAndGroupId(String uuid,
                                                                                        long groupId)
                                               throws PortalException,
                                                      SystemException

Returns the journal folder matching the UUID and group.

Parameters:

uuid - the journal folder's UUID

groupId - the primary key of the group

Returns:

the matching journal folder

Throws:

PortalException - if a matching journal folder could not be found

SystemException - if a system exception occurred

getJournalFolders

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

Returns a range of all the journal folders.

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 JournalFolderModelImpl. 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 journal folders

end - the upper bound of the range of journal folders (not inclusive)

Returns:

the range of journal folders

Throws:

SystemException - if a system exception occurred

getJournalFoldersCount

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

Returns the number of journal folders.

Returns:

the number of journal folders

Throws:

SystemException - if a system exception occurred

updateJournalFolder

@Indexable(type=REINDEX)
JournalFolder updateJournalFolder(JournalFolder journalFolder)
                                  throws SystemException

Updates the journal folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

journalFolder - the journal folder

Returns:

the journal folder that was updated

Throws:

SystemException - if a system exception occurred

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

addFolder

JournalFolder addFolder(long userId,
                        long groupId,
                        long parentFolderId,
                        String name,
                        String description,
                        ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteFolder

@Indexable(type=DELETE)
@SystemEvent(action=1,
             send=false,
             type=1)
JournalFolder deleteFolder(JournalFolder folder)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteFolder

@Indexable(type=DELETE)
@SystemEvent(action=1,
             send=false,
             type=1)
JournalFolder deleteFolder(JournalFolder folder,
                                                                         boolean includeTrashedEntries)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteFolder

@Indexable(type=DELETE)
JournalFolder deleteFolder(long folderId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteFolder

@Indexable(type=DELETE)
JournalFolder deleteFolder(long folderId,
                                               boolean includeTrashedEntries)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteFolders

void deleteFolders(long groupId)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

fetchFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder fetchFolder(long folderId)
                          throws SystemException

Throws:

SystemException

fetchFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder fetchFolder(long groupId,
                                                                   long parentFolderId,
                                                                   String name)
                          throws SystemException

Throws:

SystemException

fetchFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder fetchFolder(long groupId,
                                                                   String name)
                          throws SystemException

Throws:

SystemException

getCompanyFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFolder> getCompanyFolders(long companyId,
                                                                               int start,
                                                                               int end)
                                      throws SystemException

Throws:

SystemException

getCompanyFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyFoldersCount(long companyId)
                           throws SystemException

Throws:

SystemException

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder getFolder(long folderId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFolder> getFolders(long groupId)
                               throws SystemException

Throws:

SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFolder> getFolders(long groupId,
                                                                        long parentFolderId)
                               throws SystemException

Throws:

SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFolder> getFolders(long groupId,
                                                                        long parentFolderId,
                                                                        int status)
                               throws SystemException

Throws:

SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFolder> getFolders(long groupId,
                                                                        long parentFolderId,
                                                                        int start,
                                                                        int end)
                               throws SystemException

Throws:

SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFolder> getFolders(long groupId,
                                                                        long parentFolderId,
                                                                        int status,
                                                                        int start,
                                                                        int end)
                               throws SystemException

Throws:

SystemException

getFoldersAndArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndArticles(long groupId,
                                                                            long folderId)
                                   throws SystemException

Throws:

SystemException

getFoldersAndArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndArticles(long groupId,
                                                                            long folderId,
                                                                            int status)
                                   throws SystemException

Throws:

SystemException

getFoldersAndArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndArticles(long groupId,
                                                                            long folderId,
                                                                            int start,
                                                                            int end,
                                                                            OrderByComparator obc)
                                   throws SystemException

Throws:

SystemException

getFoldersAndArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndArticlesCount(long groupId,
                                                                        List<Long> folderIds,
                                                                        int status)
                               throws SystemException

Throws:

SystemException

getFoldersAndArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndArticlesCount(long groupId,
                                                                        long folderId)
                               throws SystemException

Throws:

SystemException

getFoldersAndArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndArticlesCount(long groupId,
                                                                        long folderId,
                                                                        int status)
                               throws SystemException

Throws:

SystemException

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                             long parentFolderId)
                    throws SystemException

Throws:

SystemException

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                             long parentFolderId,
                                                             int status)
                    throws SystemException

Throws:

SystemException

getNoAssetFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<JournalFolder> getNoAssetFolders()
                                      throws SystemException

Throws:

SystemException

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(List<Long> folderIds,
                                                              long groupId,
                                                              long folderId)
                     throws SystemException

Throws:

SystemException

moveFolder

@Indexable(type=REINDEX)
JournalFolder moveFolder(long folderId,
                                              long parentFolderId,
                                              ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

moveFolderFromTrash

JournalFolder moveFolderFromTrash(long userId,
                                  long folderId,
                                  long parentFolderId,
                                  ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

moveFolderToTrash

JournalFolder moveFolderToTrash(long userId,
                                long folderId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

rebuildTree

void rebuildTree(long companyId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

rebuildTree

void rebuildTree(long companyId,
                 long parentFolderId,
                 String parentTreePath,
                 boolean reindex)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

restoreFolderFromTrash

void restoreFolderFromTrash(long userId,
                            long folderId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateAsset

void updateAsset(long userId,
                 JournalFolder folder,
                 long[] assetCategoryIds,
                 String[] assetTagNames,
                 long[] assetLinkEntryIds)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

updateFolder

@Indexable(type=REINDEX)
JournalFolder updateFolder(long userId,
                                                long folderId,
                                                long parentFolderId,
                                                String name,
                                                String description,
                                                boolean mergeWithParentFolder,
                                                ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateStatus

JournalFolder updateStatus(long userId,
                           JournalFolder folder,
                           int status)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException