Liferay 7.0-ce-m6

com.liferay.portlet.journal.service
Class JournalFolderLocalServiceUtil

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

@ProviderType
public class JournalFolderLocalServiceUtil
extends Object

Provides the local service utility for JournalFolder. This utility wraps 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, JournalFolderLocalServiceBaseImpl, JournalFolderLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching 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 fetchJournalFolderByUuidAndGroupId(String uuid, long groupId)
          Returns the journal folder matching the UUID and group.
static ActionableDynamicQuery getActionableDynamicQuery()
           
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 List<DDMStructure> getDDMStructures(long[] groupIds, long folderId, int restrictionType)
           
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
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 long getInheritedWorkflowFolderId(long folderId)
           
static JournalFolder getJournalFolder(long folderId)
          Returns the journal folder with the primary key.
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 List<JournalFolder> getJournalFoldersByUuidAndCompanyId(String uuid, long companyId)
          Returns all the journal folders matching the UUID and company.
static List<JournalFolder> getJournalFoldersByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<JournalFolder> orderByComparator)
          Returns a range of journal folders matching the UUID and company.
static int getJournalFoldersCount()
          Returns the number of journal folders.
static List<JournalFolder> getNoAssetFolders()
           
static long getOverridedDDMStructuresFolderId(long folderId)
           
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 subscribe(long userId, long groupId, long folderId)
           
static void unsubscribe(long userId, long groupId, long folderId)
           
static void updateAsset(long userId, JournalFolder folder, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds)
           
static JournalFolder updateFolder(long userId, long groupId, long folderId, long parentFolderId, String name, String description, boolean mergeWithParentFolder, ServiceContext serviceContext)
           
static JournalFolder updateFolder(long userId, long groupId, long folderId, long parentFolderId, String name, String description, long[] ddmStructureIds, int restrictionType, boolean mergeWithParentFolder, ServiceContext serviceContext)
           
static void updateFolderDDMStructures(JournalFolder folder, long[] ddmStructureIdsArray)
           
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)
           
static void validateFolderDDMStructures(long folderId, long parentFolderId)
           
 
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

addFolder

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

addJournalFolder

public static JournalFolder addJournalFolder(JournalFolder journalFolder)
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

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

deleteFolder

public static JournalFolder deleteFolder(JournalFolder folder)
                                  throws PortalException
Throws:
PortalException

deleteFolder

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

deleteFolder

public static JournalFolder deleteFolder(long folderId)
                                  throws PortalException
Throws:
PortalException

deleteFolder

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

deleteFolders

public static void deleteFolders(long groupId)
                          throws PortalException
Throws:
PortalException

deleteJournalFolder

public static JournalFolder deleteJournalFolder(long folderId)
                                         throws PortalException
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

deleteJournalFolder

public static JournalFolder deleteJournalFolder(JournalFolder journalFolder)
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

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchFolder

public static JournalFolder fetchFolder(long folderId)

fetchFolder

public static JournalFolder fetchFolder(long groupId,
                                        String name)

fetchFolder

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

fetchJournalFolder

public static JournalFolder fetchJournalFolder(long folderId)

fetchJournalFolderByUuidAndGroupId

public static JournalFolder fetchJournalFolderByUuidAndGroupId(String uuid,
                                                               long groupId)
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

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getCompanyFolders

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

getCompanyFoldersCount

public static int getCompanyFoldersCount(long companyId)

getDDMStructures

public static List<DDMStructure> getDDMStructures(long[] groupIds,
                                                  long folderId,
                                                  int restrictionType)
                                           throws PortalException
Throws:
PortalException

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFolder

public static JournalFolder getFolder(long folderId)
                               throws PortalException
Throws:
PortalException

getFolders

public static List<JournalFolder> getFolders(long groupId)

getFolders

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

getFolders

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

getFolders

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

getFolders

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

getFoldersAndArticles

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

getFoldersAndArticles

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

getFoldersAndArticles

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

getFoldersAndArticlesCount

public static int getFoldersAndArticlesCount(long groupId,
                                             long folderId)

getFoldersAndArticlesCount

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

getFoldersAndArticlesCount

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

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId)

getFoldersCount

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

getInheritedWorkflowFolderId

public static long getInheritedWorkflowFolderId(long folderId)
                                         throws NoSuchFolderException
Throws:
NoSuchFolderException

getJournalFolder

public static JournalFolder getJournalFolder(long folderId)
                                      throws PortalException
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

getJournalFolderByUuidAndGroupId

public static JournalFolder getJournalFolderByUuidAndGroupId(String uuid,
                                                             long groupId)
                                                      throws PortalException
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

getJournalFolders

public static List<JournalFolder> getJournalFolders(int start,
                                                    int end)
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

getJournalFoldersByUuidAndCompanyId

public static List<JournalFolder> getJournalFoldersByUuidAndCompanyId(String uuid,
                                                                      long companyId)
Returns all the journal folders matching the UUID and company.

Parameters:
uuid - the UUID of the journal folders
companyId - the primary key of the company
Returns:
the matching journal folders, or an empty list if no matches were found

getJournalFoldersByUuidAndCompanyId

public static List<JournalFolder> getJournalFoldersByUuidAndCompanyId(String uuid,
                                                                      long companyId,
                                                                      int start,
                                                                      int end,
                                                                      OrderByComparator<JournalFolder> orderByComparator)
Returns a range of journal folders matching the UUID and company.

Parameters:
uuid - the UUID of the journal folders
companyId - the primary key of the company
start - the lower bound of the range of journal folders
end - the upper bound of the range of journal folders (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the range of matching journal folders, or an empty list if no matches were found

getJournalFoldersCount

public static int getJournalFoldersCount()
Returns the number of journal folders.

Returns:
the number of journal folders

getNoAssetFolders

public static List<JournalFolder> getNoAssetFolders()

getOverridedDDMStructuresFolderId

public static long getOverridedDDMStructuresFolderId(long folderId)
                                              throws NoSuchFolderException
Throws:
NoSuchFolderException

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getSubfolderIds

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

moveFolder

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

moveFolderFromTrash

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

moveFolderToTrash

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

rebuildTree

public static void rebuildTree(long companyId)
                        throws PortalException
Throws:
PortalException

rebuildTree

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

restoreFolderFromTrash

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

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

subscribe

public static void subscribe(long userId,
                             long groupId,
                             long folderId)
                      throws PortalException
Throws:
PortalException

unsubscribe

public static void unsubscribe(long userId,
                               long groupId,
                               long folderId)
                        throws PortalException
Throws:
PortalException

updateAsset

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

updateFolder

public static JournalFolder updateFolder(long userId,
                                         long groupId,
                                         long folderId,
                                         long parentFolderId,
                                         String name,
                                         String description,
                                         long[] ddmStructureIds,
                                         int restrictionType,
                                         boolean mergeWithParentFolder,
                                         ServiceContext serviceContext)
                                  throws PortalException
Throws:
PortalException

updateFolder

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

updateFolderDDMStructures

public static void updateFolderDDMStructures(JournalFolder folder,
                                             long[] ddmStructureIdsArray)
                                      throws PortalException
Throws:
PortalException

updateJournalFolder

public static JournalFolder updateJournalFolder(JournalFolder journalFolder)
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

updateStatus

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

validateFolderDDMStructures

public static void validateFolderDDMStructures(long folderId,
                                               long parentFolderId)
                                        throws PortalException
Throws:
PortalException

getService

public static JournalFolderLocalService getService()

setService

@Deprecated
public void setService(JournalFolderLocalService service)
Deprecated. As of 6.2.0


Liferay 7.0-ce-m6