com.liferay.portlet.journal.service
Class JournalFolderLocalServiceUtil

java.lang.Object
  com.liferay.portlet.journal.service.JournalFolderLocalServiceUtil

@ProviderType
public class JournalFolderLocalServiceUtil
extends Object

Provides the local service utility for JournalFolder. This utility wraps com.liferay.portlet.journal.service.impl.JournalFolderLocalServiceImpl 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.

See Also:

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

Constructor Summary

JournalFolderLocalServiceUtil()

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JournalFolderLocalServiceUtil

public JournalFolderLocalServiceUtil()

Method Detail

addJournalFolder

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

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

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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static JournalFolder fetchJournalFolder(long folderId)
                                        throws SystemException

Throws:

SystemException

fetchJournalFolderByUuidAndCompanyId

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

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

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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getJournalFolderByUuidAndCompanyId

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

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

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

public static int getJournalFoldersCount()
                                  throws SystemException

Returns the number of journal folders.

Returns:

the number of journal folders

Throws:

SystemException - if a system exception occurred

updateJournalFolder

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

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addFolder

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

Throws:

PortalException

SystemException

deleteFolder

public static JournalFolder deleteFolder(JournalFolder folder)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

deleteFolder

public static JournalFolder deleteFolder(JournalFolder folder,
                                         boolean includeTrashedEntries)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

deleteFolder

public static JournalFolder deleteFolder(long folderId)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

deleteFolder

public static JournalFolder deleteFolder(long folderId,
                                         boolean includeTrashedEntries)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

deleteFolders

public static void deleteFolders(long groupId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

fetchFolder

public static JournalFolder fetchFolder(long folderId)
                                 throws SystemException

Throws:

SystemException

fetchFolder

public static JournalFolder fetchFolder(long groupId,
                                        long parentFolderId,
                                        String name)
                                 throws SystemException

Throws:

SystemException

fetchFolder

public static JournalFolder fetchFolder(long groupId,
                                        String name)
                                 throws SystemException

Throws:

SystemException

getCompanyFolders

public static List<JournalFolder> getCompanyFolders(long companyId,
                                                    int start,
                                                    int end)
                                             throws SystemException

Throws:

SystemException

getCompanyFoldersCount

public static int getCompanyFoldersCount(long companyId)
                                  throws SystemException

Throws:

SystemException

getFolder

public static JournalFolder getFolder(long folderId)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getFolders

public static List<JournalFolder> getFolders(long groupId)
                                      throws SystemException

Throws:

SystemException

getFolders

public static List<JournalFolder> getFolders(long groupId,
                                             long parentFolderId)
                                      throws SystemException

Throws:

SystemException

getFolders

public static List<JournalFolder> getFolders(long groupId,
                                             long parentFolderId,
                                             int status)
                                      throws SystemException

Throws:

SystemException

getFolders

public static List<JournalFolder> getFolders(long groupId,
                                             long parentFolderId,
                                             int start,
                                             int end)
                                      throws SystemException

Throws:

SystemException

getFolders

public static List<JournalFolder> getFolders(long groupId,
                                             long parentFolderId,
                                             int status,
                                             int start,
                                             int end)
                                      throws SystemException

Throws:

SystemException

getFoldersAndArticles

public static List<Object> getFoldersAndArticles(long groupId,
                                                 long folderId)
                                          throws SystemException

Throws:

SystemException

getFoldersAndArticles

public static List<Object> getFoldersAndArticles(long groupId,
                                                 long folderId,
                                                 int status)
                                          throws SystemException

Throws:

SystemException

getFoldersAndArticles

public static List<Object> getFoldersAndArticles(long groupId,
                                                 long folderId,
                                                 int start,
                                                 int end,
                                                 OrderByComparator obc)
                                          throws SystemException

Throws:

SystemException

getFoldersAndArticlesCount

public static int getFoldersAndArticlesCount(long groupId,
                                             List<Long> folderIds,
                                             int status)
                                      throws SystemException

Throws:

SystemException

getFoldersAndArticlesCount

public static int getFoldersAndArticlesCount(long groupId,
                                             long folderId)
                                      throws SystemException

Throws:

SystemException

getFoldersAndArticlesCount

public static int getFoldersAndArticlesCount(long groupId,
                                             long folderId,
                                             int status)
                                      throws SystemException

Throws:

SystemException

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId)
                           throws SystemException

Throws:

SystemException

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId,
                                  int status)
                           throws SystemException

Throws:

SystemException

getNoAssetFolders

public static List<JournalFolder> getNoAssetFolders()
                                             throws SystemException

Throws:

SystemException

getSubfolderIds

public static void getSubfolderIds(List<Long> folderIds,
                                   long groupId,
                                   long folderId)
                            throws SystemException

Throws:

SystemException

moveFolder

public static JournalFolder moveFolder(long folderId,
                                       long parentFolderId,
                                       ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

moveFolderFromTrash

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

Throws:

PortalException

SystemException

moveFolderToTrash

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

Throws:

PortalException

SystemException

rebuildTree

public static void rebuildTree(long companyId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

rebuildTree

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

Throws:

PortalException

SystemException

restoreFolderFromTrash

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

Throws:

PortalException

SystemException

updateAsset

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

Throws:

PortalException

SystemException

updateFolder

public static JournalFolder updateFolder(long userId,
                                         long folderId,
                                         long parentFolderId,
                                         String name,
                                         String description,
                                         boolean mergeWithParentFolder,
                                         ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

updateStatus

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

Throws:

PortalException

SystemException

getService

public static JournalFolderLocalService getService()

setService

public void setService(JournalFolderLocalService service)

Deprecated. As of 6.2.0