com.liferay.bookmarks.service

Interface BookmarksFolderLocalService

All Superinterfaces:

BaseLocalService, PermissionedModelLocalService, PersistedModelLocalService

All Known Implementing Classes:

BookmarksFolderLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface BookmarksFolderLocalService
extends BaseLocalService, PermissionedModelLocalService

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

BookmarksFolderLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
BookmarksFolder	addBookmarksFolder(BookmarksFolder bookmarksFolder) Adds the bookmarks folder to the database.
BookmarksFolder	addFolder(long userId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
BookmarksFolder	createBookmarksFolder(long folderId) Creates a new bookmarks folder with the primary key.
BookmarksFolder	deleteBookmarksFolder(BookmarksFolder bookmarksFolder) Deletes the bookmarks folder from the database.
BookmarksFolder	deleteBookmarksFolder(long folderId) Deletes the bookmarks folder with the primary key from the database.
BookmarksFolder	deleteFolder(BookmarksFolder folder)
BookmarksFolder	deleteFolder(BookmarksFolder folder, boolean includeTrashedEntries)
BookmarksFolder	deleteFolder(long folderId)
BookmarksFolder	deleteFolder(long folderId, boolean includeTrashedEntries)
void	deleteFolders(long groupId)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<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.
<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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
BookmarksFolder	fetchBookmarksFolder(long folderId)
BookmarksFolder	fetchBookmarksFolderByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the bookmarks folder matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
BookmarksFolder	getBookmarksFolder(long folderId) Returns the bookmarks folder with the primary key.
BookmarksFolder	getBookmarksFolderByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the bookmarks folder matching the UUID and group.
java.util.List<BookmarksFolder>	getBookmarksFolders(int start, int end) Returns a range of all the bookmarks folders.
java.util.List<BookmarksFolder>	getBookmarksFoldersByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the bookmarks folders matching the UUID and company.
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.
int	getBookmarksFoldersCount() Returns the number of bookmarks folders.
java.util.List<BookmarksFolder>	getCompanyFolders(long companyId, int start, int end)
int	getCompanyFoldersCount(long companyId)
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
BookmarksFolder	getFolder(long folderId)
java.util.List<BookmarksFolder>	getFolders(long groupId)
java.util.List<BookmarksFolder>	getFolders(long groupId, long parentFolderId)
java.util.List<BookmarksFolder>	getFolders(long groupId, long parentFolderId, int start, int end)
java.util.List<BookmarksFolder>	getFolders(long groupId, long parentFolderId, int status, int start, int end)
java.util.List<java.lang.Object>	getFoldersAndEntries(long groupId, long folderId)
java.util.List<java.lang.Object>	getFoldersAndEntries(long groupId, long folderId, int status)
java.util.List<java.lang.Object>	getFoldersAndEntries(long groupId, long folderId, int status, int start, int end)
java.util.List<java.lang.Object>	getFoldersAndEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator obc)
int	getFoldersAndEntriesCount(long groupId, long folderId, int status)
int	getFoldersCount(long groupId, long parentFolderId)
int	getFoldersCount(long groupId, long parentFolderId, int status)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.util.List<BookmarksFolder>	getNoAssetFolders()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
void	getSubfolderIds(java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
void	mergeFolders(long folderId, long parentFolderId)
BookmarksFolder	moveFolder(long folderId, long parentFolderId)
BookmarksFolder	moveFolderFromTrash(long userId, long folderId, long parentFolderId)
BookmarksFolder	moveFolderToTrash(long userId, long folderId)
void	rebuildTree(long companyId)
void	rebuildTree(long companyId, long parentFolderId, java.lang.String parentTreePath, boolean reindex)
BookmarksFolder	restoreFolderFromTrash(long userId, long folderId)
void	subscribeFolder(long userId, long groupId, long folderId)
void	unsubscribeFolder(long userId, long groupId, long folderId)
void	updateAsset(long userId, BookmarksFolder folder, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds, java.lang.Double priority)
BookmarksFolder	updateBookmarksFolder(BookmarksFolder bookmarksFolder) Updates the bookmarks folder in the database or adds it if it does not yet exist.
BookmarksFolder	updateFolder(long userId, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, boolean mergeWithParentFolder, ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), replaced by updateFolder(long, long, long, String, String, ServiceContext) and mergeFolders(long, long)
BookmarksFolder	updateFolder(long userId, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
BookmarksFolder	updateStatus(long userId, BookmarksFolder folder, int status)

Method Detail

addBookmarksFolder

@Indexable(type=REINDEX)
BookmarksFolder addBookmarksFolder(BookmarksFolder bookmarksFolder)

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

addFolder

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

Throws:

PortalException

createBookmarksFolder

@Transactional(enabled=false)
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

@Indexable(type=DELETE)
BookmarksFolder deleteBookmarksFolder(BookmarksFolder bookmarksFolder)

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

deleteBookmarksFolder

@Indexable(type=DELETE)
BookmarksFolder deleteBookmarksFolder(long folderId)
                                                       throws PortalException

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

deleteFolder

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
BookmarksFolder deleteFolder(BookmarksFolder folder)
                                                                                           throws PortalException

Throws:

PortalException

deleteFolder

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
BookmarksFolder deleteFolder(BookmarksFolder folder,
                                                                                                  boolean includeTrashedEntries)
                                                                                           throws PortalException

Throws:

PortalException

deleteFolder

@Indexable(type=DELETE)
BookmarksFolder deleteFolder(long folderId)
                                              throws PortalException

Throws:

PortalException

deleteFolder

@Indexable(type=DELETE)
BookmarksFolder deleteFolder(long folderId,
                                                     boolean includeTrashedEntries)
                                              throws PortalException

Throws:

PortalException

deleteFolders

void deleteFolders(long groupId)
            throws PortalException

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksFolder fetchBookmarksFolder(long folderId)

fetchBookmarksFolderByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getBookmarksFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBookmarksFoldersCount()

Returns the number of bookmarks folders.

Returns:

the number of bookmarks folders

getCompanyFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<BookmarksFolder> getCompanyFolders(long companyId,
                                                                                                                     int start,
                                                                                                                     int end)

getCompanyFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyFoldersCount(long companyId)

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFolder

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksFolder getFolder(long folderId)
                                                                                      throws PortalException

Throws:

PortalException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<BookmarksFolder> getFolders(long groupId)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<BookmarksFolder> getFolders(long groupId,
                                                                                                              long parentFolderId)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<BookmarksFolder> getFolders(long groupId,
                                                                                                              long parentFolderId,
                                                                                                              int start,
                                                                                                              int end)

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<BookmarksFolder> getFolders(long groupId,
                                                                                                              long parentFolderId,
                                                                                                              int status,
                                                                                                              int start,
                                                                                                              int end)

getFoldersAndEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
                                                                                                                         long folderId)

getFoldersAndEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
                                                                                                                         long folderId,
                                                                                                                         int status)

getFoldersAndEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
                                                                                                                         long folderId,
                                                                                                                         int status,
                                                                                                                         int start,
                                                                                                                         int end)

getFoldersAndEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Object> getFoldersAndEntries(long groupId,
                                                                                                                         long folderId,
                                                                                                                         int status,
                                                                                                                         int start,
                                                                                                                         int end,
                                                                                                                         OrderByComparator obc)

getFoldersAndEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersAndEntriesCount(long groupId,
                                                                                                 long folderId,
                                                                                                 int status)

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                                                       long parentFolderId)

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                                                       long parentFolderId,
                                                                                       int status)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getNoAssetFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<BookmarksFolder> getNoAssetFolders()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(java.util.List<java.lang.Long> folderIds,
                                                                                        long groupId,
                                                                                        long folderId)

mergeFolders

void mergeFolders(long folderId,
                  long parentFolderId)
           throws PortalException

Throws:

PortalException

moveFolder

@Indexable(type=REINDEX)
BookmarksFolder moveFolder(long folderId,
                                                    long parentFolderId)
                                             throws PortalException

Throws:

PortalException

moveFolderFromTrash

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

Throws:

PortalException

moveFolderToTrash

@Indexable(type=REINDEX)
BookmarksFolder moveFolderToTrash(long userId,
                                                           long folderId)
                                                    throws PortalException

Throws:

PortalException

rebuildTree

void rebuildTree(long companyId)
          throws PortalException

Throws:

PortalException

rebuildTree

void rebuildTree(long companyId,
                 long parentFolderId,
                 java.lang.String parentTreePath,
                 boolean reindex)
          throws PortalException

Throws:

PortalException

restoreFolderFromTrash

@Indexable(type=REINDEX)
BookmarksFolder restoreFolderFromTrash(long userId,
                                                                long folderId)
                                                         throws PortalException

Throws:

PortalException

subscribeFolder

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

Throws:

PortalException

unsubscribeFolder

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

Throws:

PortalException

updateAsset

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

Throws:

PortalException

updateBookmarksFolder

@Indexable(type=REINDEX)
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.

Parameters:

bookmarksFolder - the bookmarks folder

Returns:

the bookmarks folder that was updated

updateFolder

@Deprecated
 @Indexable(type=REINDEX)
BookmarksFolder updateFolder(long userId,
                                                                   long folderId,
                                                                   long parentFolderId,
                                                                   java.lang.String name,
                                                                   java.lang.String description,
                                                                   boolean mergeWithParentFolder,
                                                                   ServiceContext serviceContext)
                                                            throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by updateFolder(long, long, long, String, String, ServiceContext) and mergeFolders(long, long)

Throws:

PortalException

updateFolder

@Indexable(type=REINDEX)
BookmarksFolder updateFolder(long userId,
                                                      long folderId,
                                                      long parentFolderId,
                                                      java.lang.String name,
                                                      java.lang.String description,
                                                      ServiceContext serviceContext)
                                               throws PortalException

Throws:

PortalException

updateStatus

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

Throws:

PortalException