|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.journal.service.JournalFolderLocalServiceUtil
@ProviderType public class JournalFolderLocalServiceUtil
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.
JournalFolderLocalService,
com.liferay.portlet.journal.service.base.JournalFolderLocalServiceBaseImpl,
com.liferay.portlet.journal.service.impl.JournalFolderLocalServiceImpl| Constructor Summary | |
|---|---|
JournalFolderLocalServiceUtil()
|
|
| Method Summary | ||
|---|---|---|
static void |
addDDMStructureJournalFolder(long structureId,
JournalFolder journalFolder)
|
|
static void |
addDDMStructureJournalFolder(long structureId,
long folderId)
|
|
static void |
addDDMStructureJournalFolders(long structureId,
List<JournalFolder> JournalFolders)
|
|
static void |
addDDMStructureJournalFolders(long structureId,
long[] folderIds)
|
|
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 void |
clearDDMStructureJournalFolders(long structureId)
|
|
static JournalFolder |
createJournalFolder(long folderId)
Creates a new journal folder with the primary key. |
|
static void |
deleteDDMStructureJournalFolder(long structureId,
JournalFolder journalFolder)
|
|
static void |
deleteDDMStructureJournalFolder(long structureId,
long folderId)
|
|
static void |
deleteDDMStructureJournalFolders(long structureId,
List<JournalFolder> JournalFolders)
|
|
static void |
deleteDDMStructureJournalFolders(long structureId,
long[] folderIds)
|
|
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
|
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
|
static
|
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
|
static
|
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<JournalFolder> |
getDDMStructureJournalFolders(long structureId)
|
|
static List<JournalFolder> |
getDDMStructureJournalFolders(long structureId,
int start,
int end)
|
|
static List<JournalFolder> |
getDDMStructureJournalFolders(long structureId,
int start,
int end,
OrderByComparator<JournalFolder> orderByComparator)
|
|
static int |
getDDMStructureJournalFoldersCount(long structureId)
|
|
static long[] |
getDDMStructurePrimaryKeys(long folderId)
Returns the structureIds of the d d m structures associated with the journal folder. |
|
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 boolean |
hasDDMStructureJournalFolder(long structureId,
long folderId)
|
|
static boolean |
hasDDMStructureJournalFolders(long structureId)
|
|
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. |
|
static void |
setDDMStructureJournalFolders(long structureId,
long[] folderIds)
|
|
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 folderId,
long parentFolderId,
String name,
String description,
boolean mergeWithParentFolder,
ServiceContext serviceContext)
|
|
static JournalFolder |
updateFolder(long userId,
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 |
|---|
public JournalFolderLocalServiceUtil()
| Method Detail |
|---|
public static void addDDMStructureJournalFolder(long structureId,
long folderId)
public static void addDDMStructureJournalFolder(long structureId,
JournalFolder journalFolder)
public static void addDDMStructureJournalFolders(long structureId,
List<JournalFolder> JournalFolders)
public static void addDDMStructureJournalFolders(long structureId,
long[] folderIds)
public static JournalFolder addFolder(long userId,
long groupId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException
PortalExceptionpublic static JournalFolder addJournalFolder(JournalFolder journalFolder)
journalFolder - the journal folder
public static void clearDDMStructureJournalFolders(long structureId)
public static JournalFolder createJournalFolder(long folderId)
folderId - the primary key for the new journal folder
public static void deleteDDMStructureJournalFolder(long structureId,
long folderId)
public static void deleteDDMStructureJournalFolder(long structureId,
JournalFolder journalFolder)
public static void deleteDDMStructureJournalFolders(long structureId,
List<JournalFolder> JournalFolders)
public static void deleteDDMStructureJournalFolders(long structureId,
long[] folderIds)
public static JournalFolder deleteFolder(JournalFolder folder)
throws PortalException
PortalException
public static JournalFolder deleteFolder(JournalFolder folder,
boolean includeTrashedEntries)
throws PortalException
PortalException
public static JournalFolder deleteFolder(long folderId)
throws PortalException
PortalException
public static JournalFolder deleteFolder(long folderId,
boolean includeTrashedEntries)
throws PortalException
PortalException
public static void deleteFolders(long groupId)
throws PortalException
PortalException
public static JournalFolder deleteJournalFolder(long folderId)
throws PortalException
folderId - the primary key of the journal folder
PortalException - if a journal folder with the primary key could not be foundpublic static JournalFolder deleteJournalFolder(JournalFolder journalFolder)
journalFolder - the journal folder
public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException
PortalExceptionpublic static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static <T> List<T> dynamicQuery(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 com.liferay.portlet.journal.model.impl.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> List<T> dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
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 com.liferay.portlet.journal.model.impl.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(DynamicQuery dynamicQuery)
dynamicQuery - the dynamic query
public static long dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
dynamicQuery - the dynamic queryprojection - the projection to apply to the query
public static JournalFolder fetchFolder(long folderId)
public static JournalFolder fetchFolder(long groupId,
String name)
public static JournalFolder fetchFolder(long groupId,
long parentFolderId,
String name)
public static JournalFolder fetchJournalFolder(long folderId)
public static JournalFolder fetchJournalFolderByUuidAndGroupId(String uuid,
long groupId)
uuid - the journal folder's UUIDgroupId - the primary key of the group
null if a matching journal folder could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static String getBeanIdentifier()
public static List<JournalFolder> getCompanyFolders(long companyId,
int start,
int end)
public static int getCompanyFoldersCount(long companyId)
public static List<JournalFolder> getDDMStructureJournalFolders(long structureId)
public static List<JournalFolder> getDDMStructureJournalFolders(long structureId,
int start,
int end)
public static List<JournalFolder> getDDMStructureJournalFolders(long structureId,
int start,
int end,
OrderByComparator<JournalFolder> orderByComparator)
public static int getDDMStructureJournalFoldersCount(long structureId)
public static long[] getDDMStructurePrimaryKeys(long folderId)
folderId - the folderId of the journal folder
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static JournalFolder getFolder(long folderId)
throws PortalException
PortalExceptionpublic static List<JournalFolder> getFolders(long groupId)
public static List<JournalFolder> getFolders(long groupId,
long parentFolderId)
public static List<JournalFolder> getFolders(long groupId,
long parentFolderId,
int start,
int end)
public static List<JournalFolder> getFolders(long groupId,
long parentFolderId,
int status)
public static List<JournalFolder> getFolders(long groupId,
long parentFolderId,
int status,
int start,
int end)
public static List<Object> getFoldersAndArticles(long groupId,
long folderId)
public static List<Object> getFoldersAndArticles(long groupId,
long folderId,
int start,
int end,
OrderByComparator<?> obc)
public static List<Object> getFoldersAndArticles(long groupId,
long folderId,
int status)
public static int getFoldersAndArticlesCount(long groupId,
long folderId)
public static int getFoldersAndArticlesCount(long groupId,
long folderId,
int status)
public static int getFoldersAndArticlesCount(long groupId,
List<Long> folderIds,
int status)
public static int getFoldersCount(long groupId,
long parentFolderId)
public static int getFoldersCount(long groupId,
long parentFolderId,
int status)
public static long getInheritedWorkflowFolderId(long folderId)
throws NoSuchFolderException
NoSuchFolderException
public static JournalFolder getJournalFolder(long folderId)
throws PortalException
folderId - the primary key of the journal folder
PortalException - if a journal folder with the primary key could not be found
public static JournalFolder getJournalFolderByUuidAndGroupId(String uuid,
long groupId)
throws PortalException
uuid - the journal folder's UUIDgroupId - the primary key of the group
PortalException - if a matching journal folder could not be found
public static 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 com.liferay.portlet.journal.model.impl.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 List<JournalFolder> getJournalFoldersByUuidAndCompanyId(String uuid,
long companyId)
uuid - the UUID of the journal folderscompanyId - the primary key of the company
public static List<JournalFolder> getJournalFoldersByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
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 List<JournalFolder> getNoAssetFolders()
public static long getOverridedDDMStructuresFolderId(long folderId)
throws NoSuchFolderException
NoSuchFolderException
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException
PortalException
public static void getSubfolderIds(List<Long> folderIds,
long groupId,
long folderId)
public static boolean hasDDMStructureJournalFolder(long structureId,
long folderId)
public static boolean hasDDMStructureJournalFolders(long structureId)
public static JournalFolder moveFolder(long folderId,
long parentFolderId,
ServiceContext serviceContext)
throws PortalException
PortalException
public static JournalFolder moveFolderFromTrash(long userId,
long folderId,
long parentFolderId,
ServiceContext serviceContext)
throws PortalException
PortalException
public static JournalFolder moveFolderToTrash(long userId,
long folderId)
throws PortalException
PortalException
public static void rebuildTree(long companyId)
throws PortalException
PortalException
public static void rebuildTree(long companyId,
long parentFolderId,
String parentTreePath,
boolean reindex)
throws PortalException
PortalException
public static void restoreFolderFromTrash(long userId,
long folderId)
throws PortalException
PortalExceptionpublic static void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
public static void setDDMStructureJournalFolders(long structureId,
long[] folderIds)
public static void subscribe(long userId,
long groupId,
long folderId)
throws PortalException
PortalException
public static void unsubscribe(long userId,
long groupId,
long folderId)
throws PortalException
PortalException
public static void updateAsset(long userId,
JournalFolder folder,
long[] assetCategoryIds,
String[] assetTagNames,
long[] assetLinkEntryIds)
throws PortalException
PortalException
public static JournalFolder updateFolder(long userId,
long folderId,
long parentFolderId,
String name,
String description,
long[] ddmStructureIds,
int restrictionType,
boolean mergeWithParentFolder,
ServiceContext serviceContext)
throws PortalException
PortalException
public static JournalFolder updateFolder(long userId,
long folderId,
long parentFolderId,
String name,
String description,
boolean mergeWithParentFolder,
ServiceContext serviceContext)
throws PortalException
PortalException
public static void updateFolderDDMStructures(JournalFolder folder,
long[] ddmStructureIdsArray)
public static JournalFolder updateJournalFolder(JournalFolder journalFolder)
journalFolder - the journal folder
public static JournalFolder updateStatus(long userId,
JournalFolder folder,
int status)
throws PortalException
PortalException
public static void validateFolderDDMStructures(long folderId,
long parentFolderId)
throws PortalException
PortalExceptionpublic static JournalFolderLocalService getService()
@Deprecated public void setService(JournalFolderLocalService service)
|
Liferay 7.0-ce-m3 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||