com.liferay.bookmarks.service

Class BookmarksFolderLocalServiceUtil

java.lang.Object

com.liferay.bookmarks.service.BookmarksFolderLocalServiceUtil

public class BookmarksFolderLocalServiceUtil
extends java.lang.Object

Provides the local service utility for BookmarksFolder. This utility wraps com.liferay.bookmarks.service.impl.BookmarksFolderLocalServiceImpl 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:

BookmarksFolderLocalService

Constructor Summary

Constructors

Constructor and Description
BookmarksFolderLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static BookmarksFolder	addBookmarksFolder(BookmarksFolder bookmarksFolder) Adds the bookmarks folder to the database.
static BookmarksFolder	addFolder(long userId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
static BookmarksFolder	createBookmarksFolder(long folderId) Creates a new bookmarks folder with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
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 PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.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> java.util.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 BookmarksFolder	fetchBookmarksFolder(long folderId)
static BookmarksFolder	fetchBookmarksFolderByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the bookmarks folder matching the UUID and group.
static ActionableDynamicQuery	getActionableDynamicQuery()
static BookmarksFolder	getBookmarksFolder(long folderId) Returns the bookmarks folder with the primary key.
static BookmarksFolder	getBookmarksFolderByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the bookmarks folder matching the UUID and group.
static java.util.List<BookmarksFolder>	getBookmarksFolders(int start, int end) Returns a range of all the bookmarks folders.
static java.util.List<BookmarksFolder>	getBookmarksFoldersByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the bookmarks folders matching the UUID and company.
static java.util.List<BookmarksFolder>	getBookmarksFoldersByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<BookmarksFolder> orderByComparator) Returns a range of bookmarks folders matching the UUID and company.
static int	getBookmarksFoldersCount() Returns the number of bookmarks folders.
static java.util.List<BookmarksFolder>	getCompanyFolders(long companyId, int start, int end)
static int	getCompanyFoldersCount(long companyId)
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static BookmarksFolder	getFolder(long folderId)
static java.util.List<BookmarksFolder>	getFolders(long groupId)
static java.util.List<BookmarksFolder>	getFolders(long groupId, long parentFolderId)
static java.util.List<BookmarksFolder>	getFolders(long groupId, long parentFolderId, int start, int end)
static java.util.List<BookmarksFolder>	getFolders(long groupId, long parentFolderId, int status, int start, int end)
static java.util.List<java.lang.Object>	getFoldersAndEntries(long groupId, long folderId)
static java.util.List<java.lang.Object>	getFoldersAndEntries(long groupId, long folderId, int status)
static java.util.List<java.lang.Object>	getFoldersAndEntries(long groupId, long folderId, int status, int start, int end)
static java.util.List<java.lang.Object>	getFoldersAndEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<?> orderByComparator)
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 IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.util.List<BookmarksFolder>	getNoAssetFolders()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static BookmarksFolderLocalService	getService()
static void	getSubfolderIds(java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
static void	mergeFolders(long folderId, long parentFolderId)
static BookmarksFolder	moveFolder(long folderId, long parentFolderId)
static BookmarksFolder	moveFolderFromTrash(long userId, long folderId, long parentFolderId)
static BookmarksFolder	moveFolderToTrash(long userId, long folderId)
static void	rebuildTree(long companyId)
static void	rebuildTree(long companyId, long parentFolderId, java.lang.String parentTreePath, boolean reindex)
static BookmarksFolder	restoreFolderFromTrash(long userId, long folderId)
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, java.lang.String[] assetTagNames, long[] assetLinkEntryIds, java.lang.Double priority)
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, java.lang.String name, java.lang.String description, 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

BookmarksFolderLocalServiceUtil

public BookmarksFolderLocalServiceUtil()

Method Detail

addBookmarksFolder

public static BookmarksFolder addBookmarksFolder(BookmarksFolder bookmarksFolder)

Adds the bookmarks folder to the database. Also notifies the appropriate model listeners.

Important: Inspect BookmarksFolderLocalServiceImpl 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:

bookmarksFolder - the bookmarks folder

Returns:

the bookmarks folder that was added

addFolder

public static BookmarksFolder addFolder(long userId,
                                        long parentFolderId,
                                        java.lang.String name,
                                        java.lang.String description,
                                        ServiceContext serviceContext)
                                 throws PortalException

Throws:

PortalException

createBookmarksFolder

public static BookmarksFolder createBookmarksFolder(long folderId)

Creates a new bookmarks folder with the primary key. Does not add the bookmarks folder to the database.

Parameters:

folderId - the primary key for the new bookmarks folder

Returns:

the new bookmarks folder

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteBookmarksFolder

public static BookmarksFolder deleteBookmarksFolder(BookmarksFolder bookmarksFolder)

Deletes the bookmarks folder from the database. Also notifies the appropriate model listeners.

Important: Inspect BookmarksFolderLocalServiceImpl 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:

bookmarksFolder - the bookmarks folder

Returns:

the bookmarks folder that was removed

deleteBookmarksFolder

public static BookmarksFolder deleteBookmarksFolder(long folderId)
                                             throws PortalException

Deletes the bookmarks folder with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect BookmarksFolderLocalServiceImpl 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 bookmarks folder

Returns:

the bookmarks folder that was removed

Throws:

PortalException - if a bookmarks folder with the primary key could not be found

deleteFolder

public static BookmarksFolder deleteFolder(BookmarksFolder folder)
                                    throws PortalException

Throws:

PortalException

deleteFolder

public static BookmarksFolder deleteFolder(BookmarksFolder folder,
                                           boolean includeTrashedEntries)
                                    throws PortalException

Throws:

PortalException

deleteFolder

public static BookmarksFolder deleteFolder(long folderId)
                                    throws PortalException

Throws:

PortalException

deleteFolder

public static BookmarksFolder deleteFolder(long folderId,
                                           boolean includeTrashedEntries)
                                    throws PortalException

Throws:

PortalException

deleteFolders

public static void deleteFolders(long groupId)
                          throws PortalException

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.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> java.util.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 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.bookmarks.model.impl.BookmarksFolderModelImpl.

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> java.util.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 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.bookmarks.model.impl.BookmarksFolderModelImpl.

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

fetchBookmarksFolder

public static BookmarksFolder fetchBookmarksFolder(long folderId)

fetchBookmarksFolderByUuidAndGroupId

public static BookmarksFolder fetchBookmarksFolderByUuidAndGroupId(java.lang.String uuid,
                                                                   long groupId)

Returns the bookmarks folder matching the UUID and group.

Parameters:

uuid - the bookmarks folder's UUID

groupId - the primary key of the group

Returns:

the matching bookmarks folder, or null if a matching bookmarks folder could not be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getBookmarksFolder

public static BookmarksFolder getBookmarksFolder(long folderId)
                                          throws PortalException

Returns the bookmarks folder with the primary key.

Parameters:

folderId - the primary key of the bookmarks folder

Returns:

the bookmarks folder

Throws:

PortalException - if a bookmarks folder with the primary key could not be found

getBookmarksFolderByUuidAndGroupId

public static BookmarksFolder getBookmarksFolderByUuidAndGroupId(java.lang.String uuid,
                                                                 long groupId)
                                                          throws PortalException

Returns the bookmarks folder matching the UUID and group.

Parameters:

uuid - the bookmarks folder's UUID

groupId - the primary key of the group

Returns:

the matching bookmarks folder

Throws:

PortalException - if a matching bookmarks folder could not be found

getBookmarksFolders

public static java.util.List<BookmarksFolder> getBookmarksFolders(int start,
                                                                  int end)

Returns a range of all the bookmarks 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.bookmarks.model.impl.BookmarksFolderModelImpl.

Parameters:

start - the lower bound of the range of bookmarks folders

end - the upper bound of the range of bookmarks folders (not inclusive)

Returns:

the range of bookmarks folders

getBookmarksFoldersByUuidAndCompanyId

public static java.util.List<BookmarksFolder> getBookmarksFoldersByUuidAndCompanyId(java.lang.String uuid,
                                                                                    long companyId)

Returns all the bookmarks folders matching the UUID and company.

Parameters:

uuid - the UUID of the bookmarks folders

companyId - the primary key of the company

Returns:

the matching bookmarks folders, or an empty list if no matches were found

getBookmarksFoldersByUuidAndCompanyId

public static java.util.List<BookmarksFolder> getBookmarksFoldersByUuidAndCompanyId(java.lang.String uuid,
                                                                                    long companyId,
                                                                                    int start,
                                                                                    int end,
                                                                                    OrderByComparator<BookmarksFolder> orderByComparator)

Returns a range of bookmarks folders matching the UUID and company.

Parameters:

uuid - the UUID of the bookmarks folders

companyId - the primary key of the company

start - the lower bound of the range of bookmarks folders

end - the upper bound of the range of bookmarks folders (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching bookmarks folders, or an empty list if no matches were found

getBookmarksFoldersCount

public static int getBookmarksFoldersCount()

Returns the number of bookmarks folders.

Returns:

the number of bookmarks folders

getCompanyFolders

public static java.util.List<BookmarksFolder> getCompanyFolders(long companyId,
                                                                int start,
                                                                int end)

getCompanyFoldersCount

public static int getCompanyFoldersCount(long companyId)

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFolder

public static BookmarksFolder getFolder(long folderId)
                                 throws PortalException

Throws:

PortalException

getFolders

public static java.util.List<BookmarksFolder> getFolders(long groupId)

getFolders

public static java.util.List<BookmarksFolder> getFolders(long groupId,
                                                         long parentFolderId)

getFolders

public static java.util.List<BookmarksFolder> getFolders(long groupId,
                                                         long parentFolderId,
                                                         int start,
                                                         int end)

getFolders

public static java.util.List<BookmarksFolder> getFolders(long groupId,
                                                         long parentFolderId,
                                                         int status,
                                                         int start,
                                                         int end)

getFoldersAndEntries

public static java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
                                                                    long folderId)

getFoldersAndEntries

public static java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
                                                                    long folderId,
                                                                    int status)

getFoldersAndEntries

public static java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
                                                                    long folderId,
                                                                    int status,
                                                                    int start,
                                                                    int end)

getFoldersAndEntries

public static java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
                                                                    long folderId,
                                                                    int status,
                                                                    int start,
                                                                    int end,
                                                                    OrderByComparator<?> orderByComparator)

getFoldersAndEntriesCount

public static int getFoldersAndEntriesCount(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 IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getNoAssetFolders

public static java.util.List<BookmarksFolder> getNoAssetFolders()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getSubfolderIds

public static void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
                                   long groupId,
                                   long folderId)

mergeFolders

public static void mergeFolders(long folderId,
                                long parentFolderId)
                         throws PortalException

Throws:

PortalException

moveFolder

public static BookmarksFolder moveFolder(long folderId,
                                         long parentFolderId)
                                  throws PortalException

Throws:

PortalException

moveFolderFromTrash

public static BookmarksFolder moveFolderFromTrash(long userId,
                                                  long folderId,
                                                  long parentFolderId)
                                           throws PortalException

Throws:

PortalException

moveFolderToTrash

public static BookmarksFolder 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,
                               java.lang.String parentTreePath,
                               boolean reindex)
                        throws PortalException

Throws:

PortalException

restoreFolderFromTrash

public static BookmarksFolder restoreFolderFromTrash(long userId,
                                                     long folderId)
                                              throws PortalException

Throws:

PortalException

subscribeFolder

public static void subscribeFolder(long userId,
                                   long groupId,
                                   long folderId)
                            throws PortalException

Throws:

PortalException

unsubscribeFolder

public static void unsubscribeFolder(long userId,
                                     long groupId,
                                     long folderId)
                              throws PortalException

Throws:

PortalException

updateAsset

public static void updateAsset(long userId,
                               BookmarksFolder folder,
                               long[] assetCategoryIds,
                               java.lang.String[] assetTagNames,
                               long[] assetLinkEntryIds,
                               java.lang.Double priority)
                        throws PortalException

Throws:

PortalException

updateBookmarksFolder

public static BookmarksFolder updateBookmarksFolder(BookmarksFolder bookmarksFolder)

Updates the bookmarks folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect BookmarksFolderLocalServiceImpl 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:

bookmarksFolder - the bookmarks folder

Returns:

the bookmarks folder that was updated

updateFolder

public static BookmarksFolder updateFolder(long userId,
                                           long folderId,
                                           long parentFolderId,
                                           java.lang.String name,
                                           java.lang.String description,
                                           ServiceContext serviceContext)
                                    throws PortalException

Throws:

PortalException

updateStatus

public static BookmarksFolder updateStatus(long userId,
                                           BookmarksFolder folder,
                                           int status)
                                    throws PortalException

Throws:

PortalException

getService

public static BookmarksFolderLocalService getService()