Class JournalFolderLocalServiceUtil

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

public class JournalFolderLocalServiceUtil extends Object
Provides the local service utility for JournalFolder. This utility wraps com.liferay.journal.service.impl.JournalFolderLocalServiceImpl and is an 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:
Generated:
  • Constructor Details

    • JournalFolderLocalServiceUtil

      public JournalFolderLocalServiceUtil()
  • Method Details

    • addFolder

      public static JournalFolder addFolder(String externalReferenceCode, long userId, long groupId, long parentFolderId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addJournalFolder

      public static JournalFolder addJournalFolder(JournalFolder journalFolder)
      Adds the journal folder to the database. Also notifies the appropriate model listeners.

      Important: Inspect JournalFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFolder

      public static JournalFolder deleteFolder(JournalFolder folder) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFolder

      public static JournalFolder deleteFolder(JournalFolder folder, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFolder

      public static JournalFolder deleteFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFolder

      public static JournalFolder deleteFolder(long folderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFolders

      public static void deleteFolders(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteJournalFolder

      public static JournalFolder deleteJournalFolder(JournalFolder journalFolder)
      Deletes the journal folder from the database. Also notifies the appropriate model listeners.

      Important: Inspect JournalFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      journalFolder - the journal folder
      Returns:
      the journal folder that was removed
    • deleteJournalFolder

      public static JournalFolder deleteJournalFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the journal folder with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect JournalFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      folderId - the primary key of the journal folder
      Returns:
      the journal folder that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a journal folder with the primary key could not be found
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.journal.model.impl.JournalFolderModelImpl.

      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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.journal.model.impl.JournalFolderModelImpl.

      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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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, long parentFolderId, String name)
    • fetchFolder

      public static JournalFolder fetchFolder(long groupId, String name)
    • fetchJournalFolder

      public static JournalFolder fetchJournalFolder(long folderId)
    • fetchJournalFolderByExternalReferenceCode

      public static JournalFolder fetchJournalFolderByExternalReferenceCode(String externalReferenceCode, long groupId)
    • 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 com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getCompanyFolders

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

      public static int getCompanyFoldersCount(long companyId)
    • getDDMStructures

      public static List<com.liferay.dynamic.data.mapping.model.DDMStructure> getDDMStructures(long[] groupIds, long folderId, int restrictionType) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getDDMStructures

      public static List<com.liferay.dynamic.data.mapping.model.DDMStructure> getDDMStructures(long[] groupIds, long folderId, int restrictionType, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.dynamic.data.mapping.model.DDMStructure> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getFolder

      public static JournalFolder getFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.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 status)
    • 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, 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 status)
    • getFoldersAndArticles

      public static List<Object> getFoldersAndArticles(long groupId, long folderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<?> orderByComparator)
    • getFoldersAndArticles

      public static List<Object> getFoldersAndArticles(long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<?> orderByComparator)
    • getFoldersAndArticlesCount

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

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

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

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

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

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getInheritedWorkflowFolderId

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

      public static JournalFolder getJournalFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the journal folder with the primary key.
      Parameters:
      folderId - the primary key of the journal folder
      Returns:
      the journal folder
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a journal folder with the primary key could not be found
    • getJournalFolderByExternalReferenceCode

      public static JournalFolder getJournalFolderByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getJournalFolderByUuidAndGroupId

      public static JournalFolder getJournalFolderByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.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:
      com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.journal.model.impl.JournalFolderModelImpl.

      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, com.liferay.portal.kernel.util.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()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getOverridedDDMStructuresFolderId

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSubfolderIds

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

      public static String getUniqueFolderName(String uuid, long groupId, long parentFolderId, String name, int count)
    • moveFolder

      public static JournalFolder moveFolder(long folderId, long parentFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveFolderFromTrash

      public static JournalFolder moveFolderFromTrash(long userId, long folderId, long parentFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveFolderToTrash

      public static JournalFolder moveFolderToTrash(long userId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • rebuildTree

      public static void rebuildTree(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • rebuildTree

      public static void rebuildTree(long companyId, long parentFolderId, String parentTreePath, boolean reindex) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • restoreFolderFromTrash

      public static void restoreFolderFromTrash(long userId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • searchDDMStructures

      public static List<com.liferay.dynamic.data.mapping.model.DDMStructure> searchDDMStructures(long companyId, long[] groupIds, long folderId, int restrictionType, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<com.liferay.dynamic.data.mapping.model.DDMStructure> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • subscribe

      public static void subscribe(long userId, long groupId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsubscribe

      public static void unsubscribe(long userId, long groupId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateAsset

      public static void updateAsset(long userId, JournalFolder folder, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds, Double priority) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFolder

      public static JournalFolder updateFolder(long userId, long groupId, long folderId, long parentFolderId, String name, String description, boolean mergeWithParentFolder, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFolder

      public static JournalFolder updateFolder(long userId, long groupId, long folderId, long parentFolderId, String name, String description, long[] ddmStructureIds, int restrictionType, boolean mergeWithParentFolder, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateFolderDDMStructures

      public static void updateFolderDDMStructures(JournalFolder folder, long[] ddmStructureIdsArray) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.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.

      Important: Inspect JournalFolderLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      journalFolder - the journal folder
      Returns:
      the journal folder that was updated
    • updateStatus

      public static JournalFolder updateStatus(long userId, JournalFolder folder, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validateFolderDDMStructures

      public static void validateFolderDDMStructures(long folderId, long parentFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static JournalFolderLocalService getService()