Liferay 6.2-ce-ga5

com.liferay.portlet.bookmarks.service
Interface BookmarksFolderLocalService

All Superinterfaces:
BaseLocalService, PermissionedModelLocalService, PersistedModelLocalService
All Known Implementing Classes:
BookmarksFolderLocalServiceBaseImpl, BookmarksFolderLocalServiceImpl, 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, BookmarksFolderLocalServiceBaseImpl, BookmarksFolderLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Method Summary
 BookmarksFolder addBookmarksFolder(BookmarksFolder bookmarksFolder)
          Adds the bookmarks folder to the database.
 BookmarksFolder addFolder(long userId, long parentFolderId, String name, 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)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 BookmarksFolder fetchBookmarksFolder(long folderId)
           
 BookmarksFolder fetchBookmarksFolderByUuidAndCompanyId(String uuid, long companyId)
          Returns the bookmarks folder with the matching UUID and company.
 BookmarksFolder fetchBookmarksFolderByUuidAndGroupId(String uuid, long groupId)
          Returns the bookmarks folder matching the UUID and group.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 BookmarksFolder getBookmarksFolder(long folderId)
          Returns the bookmarks folder with the primary key.
 BookmarksFolder getBookmarksFolderByUuidAndCompanyId(String uuid, long companyId)
          Returns the bookmarks folder with the matching UUID and company.
 BookmarksFolder getBookmarksFolderByUuidAndGroupId(String uuid, long groupId)
          Returns the bookmarks folder matching the UUID and group.
 List<BookmarksFolder> getBookmarksFolders(int start, int end)
          Returns a range of all the bookmarks folders.
 int getBookmarksFoldersCount()
          Returns the number of bookmarks folders.
 List<BookmarksFolder> getCompanyFolders(long companyId, int start, int end)
           
 int getCompanyFoldersCount(long companyId)
           
 BookmarksFolder getFolder(long folderId)
           
 List<BookmarksFolder> getFolders(long groupId)
           
 List<BookmarksFolder> getFolders(long groupId, long parentFolderId)
           
 List<BookmarksFolder> getFolders(long groupId, long parentFolderId, int start, int end)
           
 List<BookmarksFolder> getFolders(long groupId, long parentFolderId, int status, int start, int end)
           
 List<Object> getFoldersAndEntries(long groupId, long folderId)
           
 List<Object> getFoldersAndEntries(long groupId, long folderId, int status)
           
 List<Object> getFoldersAndEntries(long groupId, long folderId, int status, int start, int end)
           
 int getFoldersAndEntriesCount(long groupId, long folderId, int status)
           
 int getFoldersCount(long groupId, long parentFolderId)
           
 int getFoldersCount(long groupId, long parentFolderId, int status)
           
 List<BookmarksFolder> getNoAssetFolders()
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
           
 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, String parentTreePath, boolean reindex)
           
 void restoreFolderFromTrash(long userId, long folderId)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void subscribeFolder(long userId, long groupId, long folderId)
           
 void unsubscribeFolder(long userId, long groupId, long folderId)
           
 void updateAsset(long userId, BookmarksFolder folder, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds)
           
 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, String name, String description, boolean mergeWithParentFolder, ServiceContext serviceContext)
           
 BookmarksFolder updateStatus(long userId, BookmarksFolder folder, int status)
           
 

Method Detail

addBookmarksFolder

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksFolder fetchBookmarksFolder(long folderId)
                                     throws SystemException
Throws:
SystemException

fetchBookmarksFolderByUuidAndCompanyId

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getBookmarksFolderByUuidAndCompanyId

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBookmarksFoldersCount()
                             throws SystemException
Returns the number of bookmarks folders.

Returns:
the number of bookmarks folders
Throws:
SystemException - if a system exception occurred

updateBookmarksFolder

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

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addFolder

BookmarksFolder addFolder(long userId,
                          long parentFolderId,
                          String name,
                          String description,
                          ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

deleteFolder

@Indexable(type=DELETE)
@SystemEvent(action=1,
             send=false,
             type=1)
BookmarksFolder deleteFolder(BookmarksFolder folder)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

deleteFolder

@Indexable(type=DELETE)
@SystemEvent(action=1,
             send=false,
             type=1)
BookmarksFolder deleteFolder(BookmarksFolder folder,
                                                                           boolean includeTrashedEntries)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

deleteFolder

@Indexable(type=DELETE)
BookmarksFolder deleteFolder(long folderId)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

deleteFolder

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

deleteFolders

void deleteFolders(long groupId)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

getCompanyFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksFolder> getCompanyFolders(long companyId,
                                                                                 int start,
                                                                                 int end)
                                        throws SystemException
Throws:
SystemException

getCompanyFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyFoldersCount(long companyId)
                           throws SystemException
Throws:
SystemException

getFolder

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

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksFolder> getFolders(long groupId)
                                 throws SystemException
Throws:
SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksFolder> getFolders(long groupId,
                                                                          long parentFolderId)
                                 throws SystemException
Throws:
SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksFolder> getFolders(long groupId,
                                                                          long parentFolderId,
                                                                          int start,
                                                                          int end)
                                 throws SystemException
Throws:
SystemException

getFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksFolder> getFolders(long groupId,
                                                                          long parentFolderId,
                                                                          int status,
                                                                          int start,
                                                                          int end)
                                 throws SystemException
Throws:
SystemException

getFoldersAndEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndEntries(long groupId,
                                                                           long folderId)
                                  throws SystemException
Throws:
SystemException

getFoldersAndEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndEntries(long groupId,
                                                                           long folderId,
                                                                           int status)
                                  throws SystemException
Throws:
SystemException

getFoldersAndEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Object> getFoldersAndEntries(long groupId,
                                                                           long folderId,
                                                                           int status,
                                                                           int start,
                                                                           int end)
                                  throws SystemException
Throws:
SystemException

getFoldersAndEntriesCount

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

getFoldersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersCount(long groupId,
                                                             long parentFolderId)
                    throws SystemException
Throws:
SystemException

getFoldersCount

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

getNoAssetFolders

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksFolder> getNoAssetFolders()
                                        throws SystemException
Throws:
SystemException

getSubfolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void getSubfolderIds(List<Long> folderIds,
                                                              long groupId,
                                                              long folderId)
                     throws SystemException
Throws:
SystemException

moveFolder

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

moveFolderFromTrash

BookmarksFolder moveFolderFromTrash(long userId,
                                    long folderId,
                                    long parentFolderId)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

moveFolderToTrash

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

rebuildTree

void rebuildTree(long companyId)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

rebuildTree

void rebuildTree(long companyId,
                 long parentFolderId,
                 String parentTreePath,
                 boolean reindex)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

restoreFolderFromTrash

@Indexable(type=REINDEX)
void restoreFolderFromTrash(long userId,
                                                 long folderId)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

subscribeFolder

void subscribeFolder(long userId,
                     long groupId,
                     long folderId)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

unsubscribeFolder

void unsubscribeFolder(long userId,
                       long groupId,
                       long folderId)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

updateAsset

void updateAsset(long userId,
                 BookmarksFolder folder,
                 long[] assetCategoryIds,
                 String[] assetTagNames,
                 long[] assetLinkEntryIds)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

updateFolder

@Indexable(type=REINDEX)
BookmarksFolder updateFolder(long userId,
                                                  long folderId,
                                                  long parentFolderId,
                                                  String name,
                                                  String description,
                                                  boolean mergeWithParentFolder,
                                                  ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

updateStatus

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

Liferay 6.2-ce-ga5