@ProviderType
public class JournalFolderLocalServiceUtil
extends java.lang.Object
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.JournalFolderLocalService
,
JournalFolderLocalServiceBaseImpl
,
JournalFolderLocalServiceImpl
Constructor and Description |
---|
JournalFolderLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static JournalFolder |
addFolder(long userId,
long groupId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
com.liferay.portal.kernel.service.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 com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <T> java.util.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.
|
static <T> java.util.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.
|
static long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
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.
|
static JournalFolder |
fetchFolder(long folderId) |
static JournalFolder |
fetchFolder(long groupId,
long parentFolderId,
java.lang.String name) |
static JournalFolder |
fetchFolder(long groupId,
java.lang.String name) |
static JournalFolder |
fetchJournalFolder(long folderId) |
static JournalFolder |
fetchJournalFolderByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the journal folder matching the UUID and group.
|
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static java.util.List<JournalFolder> |
getCompanyFolders(long companyId,
int start,
int end) |
static int |
getCompanyFoldersCount(long companyId) |
static java.util.List<com.liferay.dynamic.data.mapping.model.DDMStructure> |
getDDMStructures(long[] groupIds,
long folderId,
int restrictionType) |
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery |
getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) |
static JournalFolder |
getFolder(long folderId) |
static java.util.List<JournalFolder> |
getFolders(long groupId) |
static java.util.List<JournalFolder> |
getFolders(long groupId,
long parentFolderId) |
static java.util.List<JournalFolder> |
getFolders(long groupId,
long parentFolderId,
int status) |
static java.util.List<JournalFolder> |
getFolders(long groupId,
long parentFolderId,
int start,
int end) |
static java.util.List<JournalFolder> |
getFolders(long groupId,
long parentFolderId,
int status,
int start,
int end) |
static java.util.List<java.lang.Object> |
getFoldersAndArticles(long groupId,
long folderId) |
static java.util.List<java.lang.Object> |
getFoldersAndArticles(long groupId,
long folderId,
int status) |
static java.util.List<java.lang.Object> |
getFoldersAndArticles(long groupId,
long folderId,
int status,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<?> obc) |
static java.util.List<java.lang.Object> |
getFoldersAndArticles(long groupId,
long folderId,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<?> obc) |
static int |
getFoldersAndArticlesCount(long groupId,
java.util.List<java.lang.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 com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static long |
getInheritedWorkflowFolderId(long folderId) |
static JournalFolder |
getJournalFolder(long folderId)
Returns the journal folder with the primary key.
|
static JournalFolder |
getJournalFolderByUuidAndGroupId(java.lang.String uuid,
long groupId)
Returns the journal folder matching the UUID and group.
|
static java.util.List<JournalFolder> |
getJournalFolders(int start,
int end)
Returns a range of all the journal folders.
|
static java.util.List<JournalFolder> |
getJournalFoldersByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns all the journal folders matching the UUID and company.
|
static java.util.List<JournalFolder> |
getJournalFoldersByUuidAndCompanyId(java.lang.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.
|
static int |
getJournalFoldersCount()
Returns the number of journal folders.
|
static java.util.List<JournalFolder> |
getNoAssetFolders() |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static long |
getOverridedDDMStructuresFolderId(long folderId) |
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static JournalFolderLocalService |
getService() |
static void |
getSubfolderIds(java.util.List<java.lang.Long> folderIds,
long groupId,
long folderId) |
static JournalFolder |
moveFolder(long folderId,
long parentFolderId,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static JournalFolder |
moveFolderFromTrash(long userId,
long folderId,
long parentFolderId,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static JournalFolder |
moveFolderToTrash(long userId,
long folderId) |
static void |
rebuildTree(long companyId) |
static void |
rebuildTree(long companyId,
long parentFolderId,
java.lang.String parentTreePath,
boolean reindex) |
static void |
restoreFolderFromTrash(long userId,
long folderId) |
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,
java.lang.String[] assetTagNames,
long[] assetLinkEntryIds,
java.lang.Double priority) |
static JournalFolder |
updateFolder(long userId,
long groupId,
long folderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
boolean mergeWithParentFolder,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static JournalFolder |
updateFolder(long userId,
long groupId,
long folderId,
long parentFolderId,
java.lang.String name,
java.lang.String description,
long[] ddmStructureIds,
int restrictionType,
boolean mergeWithParentFolder,
com.liferay.portal.kernel.service.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) |
public static JournalFolder addFolder(long userId, long groupId, long parentFolderId, java.lang.String name, java.lang.String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder addJournalFolder(JournalFolder journalFolder)
journalFolder
- the journal folderpublic static JournalFolder createJournalFolder(long folderId)
folderId
- the primary key for the new journal folderpublic static JournalFolder deleteFolder(JournalFolder folder) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder deleteFolder(JournalFolder folder, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder deleteFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder deleteFolder(long folderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void deleteFolders(long groupId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder deleteJournalFolder(JournalFolder journalFolder)
journalFolder
- the journal folderpublic static JournalFolder deleteJournalFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
folderId
- the primary key of the journal folderPortalException
- if a journal folder with the primary key could not be foundpublic static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
PortalException
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static JournalFolder fetchFolder(long folderId)
public static JournalFolder fetchFolder(long groupId, long parentFolderId, java.lang.String name)
public static JournalFolder fetchFolder(long groupId, java.lang.String name)
public static JournalFolder fetchJournalFolder(long folderId)
public static JournalFolder fetchJournalFolderByUuidAndGroupId(java.lang.String uuid, long groupId)
uuid
- the journal folder's UUIDgroupId
- the primary key of the groupnull
if a matching journal folder could not be foundpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static java.util.List<JournalFolder> getCompanyFolders(long companyId, int start, int end)
public static int getCompanyFoldersCount(long companyId)
public static java.util.List<com.liferay.dynamic.data.mapping.model.DDMStructure> getDDMStructures(long[] groupIds, long folderId, int restrictionType) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
public static JournalFolder getFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static java.util.List<JournalFolder> getFolders(long groupId)
public static java.util.List<JournalFolder> getFolders(long groupId, long parentFolderId)
public static java.util.List<JournalFolder> getFolders(long groupId, long parentFolderId, int status)
public static java.util.List<JournalFolder> getFolders(long groupId, long parentFolderId, int start, int end)
public static java.util.List<JournalFolder> getFolders(long groupId, long parentFolderId, int status, int start, int end)
public static java.util.List<java.lang.Object> getFoldersAndArticles(long groupId, long folderId)
public static java.util.List<java.lang.Object> getFoldersAndArticles(long groupId, long folderId, int status)
public static java.util.List<java.lang.Object> getFoldersAndArticles(long groupId, long folderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<?> obc)
public static java.util.List<java.lang.Object> getFoldersAndArticles(long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<?> obc)
public static int getFoldersAndArticlesCount(long groupId, java.util.List<java.lang.Long> folderIds, int status)
public static int getFoldersAndArticlesCount(long groupId, long folderId)
public static int getFoldersAndArticlesCount(long groupId, long folderId, int status)
public static int getFoldersCount(long groupId, long parentFolderId)
public static int getFoldersCount(long groupId, long parentFolderId, int status)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static long getInheritedWorkflowFolderId(long folderId) throws NoSuchFolderException
NoSuchFolderException
public static JournalFolder getJournalFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
folderId
- the primary key of the journal folderPortalException
- if a journal folder with the primary key could not be foundpublic static JournalFolder getJournalFolderByUuidAndGroupId(java.lang.String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the journal folder's UUIDgroupId
- the primary key of the groupPortalException
- if a matching journal folder could not be foundpublic static java.util.List<JournalFolder> getJournalFolders(int start, int end)
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.
start
- the lower bound of the range of journal foldersend
- the upper bound of the range of journal folders (not inclusive)public static java.util.List<JournalFolder> getJournalFoldersByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the UUID of the journal folderscompanyId
- the primary key of the companypublic static java.util.List<JournalFolder> getJournalFoldersByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<JournalFolder> orderByComparator)
uuid
- the UUID of the journal folderscompanyId
- the primary key of the companystart
- the lower bound of the range of journal foldersend
- the upper bound of the range of journal folders (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static int getJournalFoldersCount()
public static java.util.List<JournalFolder> getNoAssetFolders()
public static java.lang.String getOSGiServiceIdentifier()
public static long getOverridedDDMStructuresFolderId(long folderId) throws NoSuchFolderException
NoSuchFolderException
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void getSubfolderIds(java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
public static JournalFolder moveFolder(long folderId, long parentFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder moveFolderFromTrash(long userId, long folderId, long parentFolderId, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder moveFolderToTrash(long userId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void rebuildTree(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void rebuildTree(long companyId, long parentFolderId, java.lang.String parentTreePath, boolean reindex) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void restoreFolderFromTrash(long userId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void subscribe(long userId, long groupId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void unsubscribe(long userId, long groupId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void updateAsset(long userId, JournalFolder folder, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds, java.lang.Double priority) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder updateFolder(long userId, long groupId, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, boolean mergeWithParentFolder, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder updateFolder(long userId, long groupId, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, long[] ddmStructureIds, int restrictionType, boolean mergeWithParentFolder, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void updateFolderDDMStructures(JournalFolder folder, long[] ddmStructureIdsArray) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolder updateJournalFolder(JournalFolder journalFolder)
journalFolder
- the journal folderpublic static JournalFolder updateStatus(long userId, JournalFolder folder, int status) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static void validateFolderDDMStructures(long folderId, long parentFolderId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static JournalFolderLocalService getService()