com.liferay.portlet.bookmarks.service

Class BookmarksFolderLocalServiceUtil

java.lang.Object

com.liferay.portlet.bookmarks.service.BookmarksFolderLocalServiceUtil

@ProviderType
public class BookmarksFolderLocalServiceUtil
extends java.lang.Object

Provides the local service utility for BookmarksFolder. 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. 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.

Author:

Brian Wing Shun Chan

See Also:

BookmarksFolderLocalService, com.liferay.portlet.bookmarks.service.base.BookmarksFolderLocalServiceBaseImpl, com.liferay.portlet.bookmarks.service.impl.BookmarksFolderLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
BookmarksFolderLocalServiceUtil()

Method Summary

Methods

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 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 java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static java.util.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 long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static BookmarksFolder	fetchBookmarksFolder(long folderId)
static BookmarksFolder	fetchBookmarksFolderByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the bookmarks folder with the matching UUID and company.
static BookmarksFolder	fetchBookmarksFolderByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the bookmarks folder matching the UUID and group.
static java.lang.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	getBookmarksFolderByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the bookmarks folder with the matching UUID and company.
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 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 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 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 java.util.List<BookmarksFolder>	getNoAssetFolders()
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 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	restoreFolderFromTrash(long userId, long folderId)
static void	setBeanIdentifier(java.lang.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, java.lang.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, java.lang.String name, java.lang.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

BookmarksFolderLocalServiceUtil

public BookmarksFolderLocalServiceUtil()

Method Detail

addBookmarksFolder

public static BookmarksFolder addBookmarksFolder(BookmarksFolder bookmarksFolder)
                                          throws SystemException

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

Parameters:

bookmarksFolder - the bookmarks folder

Returns:

the bookmarks folder that was added

Throws:

SystemException - if a system exception occurred

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

deleteBookmarksFolder

public static BookmarksFolder deleteBookmarksFolder(long folderId)
                                             throws PortalException,
                                                    SystemException

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

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

SystemException - if a system exception occurred

deleteBookmarksFolder

public static BookmarksFolder deleteBookmarksFolder(BookmarksFolder bookmarksFolder)
                                             throws SystemException

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

Parameters:

bookmarksFolder - the bookmarks folder

Returns:

the bookmarks folder that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                                   throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end)
                                   throws SystemException

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 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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                                   throws SystemException

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 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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchBookmarksFolder

public static BookmarksFolder fetchBookmarksFolder(long folderId)
                                            throws SystemException

Throws:

SystemException

fetchBookmarksFolderByUuidAndCompanyId

public static BookmarksFolder fetchBookmarksFolderByUuidAndCompanyId(java.lang.String uuid,
                                                     long companyId)
                                                              throws SystemException

Returns the bookmarks folder with the matching UUID and company.

Parameters:

uuid - the bookmarks folder's UUID

companyId - the primary key of the company

Returns:

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

Throws:

SystemException - if a system exception occurred

fetchBookmarksFolderByUuidAndGroupId

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

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

Throws:

SystemException - if a system exception occurred

getBookmarksFolder

public static BookmarksFolder getBookmarksFolder(long folderId)
                                          throws PortalException,
                                                 SystemException

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

SystemException - if a system exception occurred

getPersistedModel

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

Throws:

PortalException

SystemException

getBookmarksFolderByUuidAndCompanyId

public static BookmarksFolder getBookmarksFolderByUuidAndCompanyId(java.lang.String uuid,
                                                   long companyId)
                                                            throws PortalException,
                                                                   SystemException

Returns the bookmarks folder with the matching UUID and company.

Parameters:

uuid - the bookmarks folder's UUID

companyId - the primary key of the company

Returns:

the matching bookmarks folder

Throws:

PortalException - if a matching bookmarks folder could not be found

SystemException - if a system exception occurred

getBookmarksFolderByUuidAndGroupId

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

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

SystemException - if a system exception occurred

getBookmarksFolders

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

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 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.

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

Throws:

SystemException - if a system exception occurred

getBookmarksFoldersCount

public static int getBookmarksFoldersCount()
                                    throws SystemException

Returns the number of bookmarks folders.

Returns:

the number of bookmarks folders

Throws:

SystemException - if a system exception occurred

updateBookmarksFolder

public static BookmarksFolder updateBookmarksFolder(BookmarksFolder bookmarksFolder)
                                             throws SystemException

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

Parameters:

bookmarksFolder - the bookmarks folder

Returns:

the bookmarks folder that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addFolder

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

Throws:

PortalException

SystemException

deleteFolder

public static BookmarksFolder deleteFolder(BookmarksFolder folder)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

deleteFolder

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

Throws:

PortalException

SystemException

deleteFolder

public static BookmarksFolder deleteFolder(long folderId)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

deleteFolder

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

Throws:

PortalException

SystemException

deleteFolders

public static void deleteFolders(long groupId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getCompanyFolders

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

Throws:

SystemException

getCompanyFoldersCount

public static int getCompanyFoldersCount(long companyId)
                                  throws SystemException

Throws:

SystemException

getFolder

public static BookmarksFolder getFolder(long folderId)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getFolders

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

Throws:

SystemException

getFolders

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

Throws:

SystemException

getFolders

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

Throws:

SystemException

getFolders

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

Throws:

SystemException

getFoldersAndEntries

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

Throws:

SystemException

getFoldersAndEntries

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

Throws:

SystemException

getFoldersAndEntries

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

Throws:

SystemException

getFoldersAndEntriesCount

public static int getFoldersAndEntriesCount(long groupId,
                            long folderId,
                            int status)
                                     throws SystemException

Throws:

SystemException

getFoldersCount

public static int getFoldersCount(long groupId,
                  long parentFolderId)
                           throws SystemException

Throws:

SystemException

getFoldersCount

public static int getFoldersCount(long groupId,
                  long parentFolderId,
                  int status)
                           throws SystemException

Throws:

SystemException

getNoAssetFolders

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

Throws:

SystemException

getSubfolderIds

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

Throws:

SystemException

moveFolder

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

Throws:

PortalException

SystemException

moveFolderFromTrash

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

Throws:

PortalException

SystemException

moveFolderToTrash

public static BookmarksFolder moveFolderToTrash(long userId,
                                long folderId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

rebuildTree

public static void rebuildTree(long companyId)
                        throws SystemException

Throws:

SystemException

restoreFolderFromTrash

public static void restoreFolderFromTrash(long userId,
                          long folderId)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

subscribeFolder

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

Throws:

PortalException

SystemException

unsubscribeFolder

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

Throws:

PortalException

SystemException

updateAsset

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

Throws:

PortalException

SystemException

updateFolder

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

Throws:

PortalException

SystemException

updateStatus

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

Throws:

PortalException

SystemException

getService

public static BookmarksFolderLocalService getService()

setService

public void setService(BookmarksFolderLocalService service)

Deprecated. As of 6.2.0