Liferay 6.2.0-ce-m3

com.liferay.portlet.journal.service
Interface JournalFolderLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
JournalFolderLocalServiceWrapper

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

The interface for the journal folder 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:
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.
 void deleteFolder(JournalFolder folder)
           
 void deleteFolder(long folderId)
           
 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.
 JournalFolder fetchFolder(long groupId, String name)
           
 JournalFolder fetchJournalFolder(long folderId)
           
 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 start, int end)
           
 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 getFoldersCount(long groupId, long parentFolderId)
           
 JournalFolder getJournalFolder(long folderId)
          Returns the journal folder with the primary key.
 JournalFolder getJournalFolderByUuidAndGroupId(String uuid, long groupId)
          Returns the journal folder with the UUID in the group.
 List<JournalFolder> getJournalFolders(int start, int end)
          Returns a range of all the journal folders.
 int getJournalFoldersCount()
          Returns the number of journal folders.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
           
 JournalFolder moveFolder(long folderId, long parentFolderId, ServiceContext serviceContext)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 JournalFolder updateFolder(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.
 

Method Detail

addJournalFolder

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

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

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

fetchJournalFolder

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

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

getJournalFolderByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JournalFolder getJournalFolderByUuidAndGroupId(String uuid,
                                                                                        long groupId)
                                               throws PortalException,
                                                      SystemException
Returns the journal folder with the UUID in the group.

Parameters:
uuid - the UUID of journal folder
groupId - the group id of the journal folder
Returns:
the journal folder
Throws:
PortalException - if a journal folder with the UUID in the group 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

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

void deleteFolder(JournalFolder folder)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

deleteFolder

void deleteFolder(long folderId)
                  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 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 start,
                                                                        int end)
                               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

getFoldersCount

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

getSubfolderIds

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

moveFolder

JournalFolder moveFolder(long folderId,
                         long parentFolderId,
                         ServiceContext serviceContext)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

updateFolder

JournalFolder updateFolder(long folderId,
                           long parentFolderId,
                           String name,
                           String description,
                           boolean mergeWithParentFolder,
                           ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

Liferay 6.2.0-ce-m3