|
Liferay 6.2.0-ce-m5 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectcom.liferay.portlet.bookmarks.service.BookmarksFolderLocalServiceUtil
public class BookmarksFolderLocalServiceUtil
The utility for the bookmarks folder local service. This utility wraps com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.
This is a local service. 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.
BookmarksFolderLocalService,
com.liferay.portlet.bookmarks.service.base.BookmarksFolderLocalServiceBaseImpl,
com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl| Constructor Summary | |
|---|---|
BookmarksFolderLocalServiceUtil()
|
|
| Method Summary | |
|---|---|
static BookmarksFolder |
addBookmarksFolder(BookmarksFolder bookmarksFolder)
Adds the bookmarks folder to the database. |
static BookmarksFolder |
addFolder(long userId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
|
static BookmarksFolder |
createBookmarksFolder(long folderId)
Creates a new bookmarks folder with the primary key. |
static BookmarksFolder |
deleteBookmarksFolder(BookmarksFolder bookmarksFolder)
Deletes the bookmarks folder from the database. |
static BookmarksFolder |
deleteBookmarksFolder(long folderId)
Deletes the bookmarks folder with the primary key from the database. |
static BookmarksFolder |
deleteFolder(BookmarksFolder folder)
|
static BookmarksFolder |
deleteFolder(BookmarksFolder folder,
boolean includeTrashedEntries)
|
static BookmarksFolder |
deleteFolder(long folderId)
|
static BookmarksFolder |
deleteFolder(long folderId,
boolean includeTrashedEntries)
|
static void |
deleteFolders(long groupId)
|
static DynamicQuery |
dynamicQuery()
|
static List |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows. |
static List |
dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows. |
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows that match the dynamic query. |
static BookmarksFolder |
fetchBookmarksFolder(long folderId)
|
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static BookmarksFolder |
getBookmarksFolder(long folderId)
Returns the bookmarks folder with the primary key. |
static BookmarksFolder |
getBookmarksFolderByUuidAndGroupId(String uuid,
long groupId)
Returns the bookmarks folder matching the UUID and group. |
static List<BookmarksFolder> |
getBookmarksFolders(int start,
int end)
Returns a range of all the bookmarks folders. |
static int |
getBookmarksFoldersCount()
Returns the number of bookmarks folders. |
static List<BookmarksFolder> |
getCompanyFolders(long companyId,
int start,
int end)
|
static int |
getCompanyFoldersCount(long companyId)
|
static BookmarksFolder |
getFolder(long folderId)
|
static List<BookmarksFolder> |
getFolders(long groupId)
|
static List<BookmarksFolder> |
getFolders(long groupId,
long parentFolderId)
|
static List<BookmarksFolder> |
getFolders(long groupId,
long parentFolderId,
int start,
int end)
|
static List<BookmarksFolder> |
getFolders(long groupId,
long parentFolderId,
int status,
int start,
int end)
|
static List<Object> |
getFoldersAndEntries(long groupId,
long folderId)
|
static List<Object> |
getFoldersAndEntries(long groupId,
long folderId,
int status)
|
static List<Object> |
getFoldersAndEntries(long groupId,
long folderId,
int status,
int start,
int end)
|
static int |
getFoldersAndEntriesCount(long groupId,
long folderId,
int status)
|
static int |
getFoldersCount(long groupId,
long parentFolderId)
|
static int |
getFoldersCount(long groupId,
long parentFolderId,
int status)
|
static List<BookmarksFolder> |
getNoAssetFolders()
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj)
|
static BookmarksFolderLocalService |
getService()
|
static void |
getSubfolderIds(List<Long> folderIds,
long groupId,
long folderId)
|
static BookmarksFolder |
moveFolder(long folderId,
long parentFolderId)
|
static BookmarksFolder |
moveFolderFromTrash(long userId,
long folderId,
long parentFolderId)
|
static void |
moveFolderToTrash(long userId,
long folderId)
|
static void |
restoreFolderFromTrash(long userId,
long folderId)
|
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(BookmarksFolderLocalService service)
Deprecated. As of 6.2.0 |
static void |
subscribeFolder(long userId,
long groupId,
long folderId)
|
static void |
unsubscribeFolder(long userId,
long groupId,
long folderId)
|
static void |
updateAsset(long userId,
BookmarksFolder folder,
long[] assetCategoryIds,
String[] assetTagNames,
long[] assetLinkEntryIds)
|
static BookmarksFolder |
updateBookmarksFolder(BookmarksFolder bookmarksFolder)
Updates the bookmarks folder in the database or adds it if it does not yet exist. |
static BookmarksFolder |
updateFolder(long userId,
long folderId,
long parentFolderId,
String name,
String description,
boolean mergeWithParentFolder,
ServiceContext serviceContext)
|
static BookmarksFolder |
updateStatus(long userId,
BookmarksFolder folder,
int status)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public BookmarksFolderLocalServiceUtil()
| Method Detail |
|---|
public static BookmarksFolder addBookmarksFolder(BookmarksFolder bookmarksFolder)
throws SystemException
bookmarksFolder - the bookmarks folder
SystemException - if a system exception occurredpublic static BookmarksFolder createBookmarksFolder(long folderId)
folderId - the primary key for the new bookmarks folder
public static BookmarksFolder deleteBookmarksFolder(long folderId)
throws PortalException,
SystemException
folderId - the primary key of the bookmarks folder
PortalException - if a bookmarks folder with the primary key could not be found
SystemException - if a system exception occurred
public static BookmarksFolder deleteBookmarksFolder(BookmarksFolder bookmarksFolder)
throws SystemException
bookmarksFolder - the bookmarks folder
SystemException - if a system exception occurredpublic static DynamicQuery dynamicQuery()
public static List dynamicQuery(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end)
throws SystemException
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 BookmarksFolderModelImpl. 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)
SystemException - if a system exception occurred
public static List dynamicQuery(DynamicQuery dynamicQuery,
int start,
int end,
OrderByComparator orderByComparator)
throws SystemException
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 BookmarksFolderModelImpl. 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)
SystemException - if a system exception occurred
public static long dynamicQueryCount(DynamicQuery dynamicQuery)
throws SystemException
dynamicQuery - the dynamic query
SystemException - if a system exception occurred
public static BookmarksFolder fetchBookmarksFolder(long folderId)
throws SystemException
SystemException
public static BookmarksFolder getBookmarksFolder(long folderId)
throws PortalException,
SystemException
folderId - the primary key of the bookmarks folder
PortalException - if a bookmarks folder with the primary key could not be found
SystemException - if a system exception occurred
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException,
SystemException
PortalException
SystemException
public static BookmarksFolder getBookmarksFolderByUuidAndGroupId(String uuid,
long groupId)
throws PortalException,
SystemException
uuid - the bookmarks folder's UUIDgroupId - the primary key of the group
PortalException - if a matching bookmarks folder could not be found
SystemException - if a system exception occurred
public static List<BookmarksFolder> getBookmarksFolders(int start,
int end)
throws SystemException
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 BookmarksFolderModelImpl. 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 bookmarks foldersend - the upper bound of the range of bookmarks folders (not inclusive)
SystemException - if a system exception occurred
public static int getBookmarksFoldersCount()
throws SystemException
SystemException - if a system exception occurred
public static BookmarksFolder updateBookmarksFolder(BookmarksFolder bookmarksFolder)
throws SystemException
bookmarksFolder - the bookmarks folder
SystemException - if a system exception occurredpublic static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier - the Spring bean ID for this bean
public static BookmarksFolder addFolder(long userId,
long parentFolderId,
String name,
String description,
ServiceContext serviceContext)
throws PortalException,
SystemException
PortalException
SystemException
public static BookmarksFolder deleteFolder(BookmarksFolder folder)
throws PortalException,
SystemException
PortalException
SystemException
public static BookmarksFolder deleteFolder(BookmarksFolder folder,
boolean includeTrashedEntries)
throws PortalException,
SystemException
PortalException
SystemException
public static BookmarksFolder deleteFolder(long folderId)
throws PortalException,
SystemException
PortalException
SystemException
public static BookmarksFolder deleteFolder(long folderId,
boolean includeTrashedEntries)
throws PortalException,
SystemException
PortalException
SystemException
public static void deleteFolders(long groupId)
throws PortalException,
SystemException
PortalException
SystemException
public static List<BookmarksFolder> getCompanyFolders(long companyId,
int start,
int end)
throws SystemException
SystemException
public static int getCompanyFoldersCount(long companyId)
throws SystemException
SystemException
public static BookmarksFolder getFolder(long folderId)
throws PortalException,
SystemException
PortalException
SystemException
public static List<BookmarksFolder> getFolders(long groupId)
throws SystemException
SystemException
public static List<BookmarksFolder> getFolders(long groupId,
long parentFolderId)
throws SystemException
SystemException
public static List<BookmarksFolder> getFolders(long groupId,
long parentFolderId,
int start,
int end)
throws SystemException
SystemException
public static List<BookmarksFolder> getFolders(long groupId,
long parentFolderId,
int status,
int start,
int end)
throws SystemException
SystemException
public static List<Object> getFoldersAndEntries(long groupId,
long folderId)
throws SystemException
SystemException
public static List<Object> getFoldersAndEntries(long groupId,
long folderId,
int status)
throws SystemException
SystemException
public static List<Object> getFoldersAndEntries(long groupId,
long folderId,
int status,
int start,
int end)
throws SystemException
SystemException
public static int getFoldersAndEntriesCount(long groupId,
long folderId,
int status)
throws SystemException
SystemException
public static int getFoldersCount(long groupId,
long parentFolderId)
throws SystemException
SystemException
public static int getFoldersCount(long groupId,
long parentFolderId,
int status)
throws SystemException
SystemException
public static List<BookmarksFolder> getNoAssetFolders()
throws SystemException
SystemException
public static void getSubfolderIds(List<Long> folderIds,
long groupId,
long folderId)
throws SystemException
SystemException
public static BookmarksFolder moveFolder(long folderId,
long parentFolderId)
throws PortalException,
SystemException
PortalException
SystemException
public static BookmarksFolder moveFolderFromTrash(long userId,
long folderId,
long parentFolderId)
throws PortalException,
SystemException
PortalException
SystemException
public static void moveFolderToTrash(long userId,
long folderId)
throws PortalException,
SystemException
PortalException
SystemException
public static void restoreFolderFromTrash(long userId,
long folderId)
throws PortalException,
SystemException
PortalException
SystemException
public static void subscribeFolder(long userId,
long groupId,
long folderId)
throws PortalException,
SystemException
PortalException
SystemException
public static void unsubscribeFolder(long userId,
long groupId,
long folderId)
throws PortalException,
SystemException
PortalException
SystemException
public static void updateAsset(long userId,
BookmarksFolder folder,
long[] assetCategoryIds,
String[] assetTagNames,
long[] assetLinkEntryIds)
throws PortalException,
SystemException
PortalException
SystemException
public static BookmarksFolder updateFolder(long userId,
long folderId,
long parentFolderId,
String name,
String description,
boolean mergeWithParentFolder,
ServiceContext serviceContext)
throws PortalException,
SystemException
PortalException
SystemException
public static BookmarksFolder updateStatus(long userId,
BookmarksFolder folder,
int status)
throws PortalException,
SystemException
PortalException
SystemExceptionpublic static BookmarksFolderLocalService getService()
public void setService(BookmarksFolderLocalService service)
|
Liferay 6.2.0-ce-m5 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||