com.liferay.bookmarks.service

Interface BookmarksFolderService

All Superinterfaces:

BaseService

All Known Implementing Classes:

BookmarksFolderServiceWrapper

@AccessControlled
 @JSONWebService
 @ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface BookmarksFolderService
extends BaseService

Provides the remote service interface for BookmarksFolder. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

BookmarksFolderServiceUtil

Method Summary

Modifier and Type	Method and Description
BookmarksFolder	addFolder(long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)
void	deleteFolder(long folderId)
void	deleteFolder(long folderId, boolean includeTrashedEntries)
BookmarksFolder	getFolder(long folderId)
java.util.List<java.lang.Long>	getFolderIds(long groupId, 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)
int	getFoldersAndEntriesCount(long groupId, long folderId)
int	getFoldersAndEntriesCount(long groupId, long folderId, int status)
int	getFoldersCount(long groupId, long parentFolderId)
int	getFoldersCount(long groupId, long parentFolderId, int status)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
void	getSubfolderIds(java.util.List<java.lang.Long> folderIds, long groupId, long folderId, boolean recurse)
java.util.List<java.lang.Long>	getSubfolderIds(long groupId, long folderId, boolean recurse)
void	mergeFolders(long folderId, long parentFolderId)
BookmarksFolder	moveFolder(long folderId, long parentFolderId)
BookmarksFolder	moveFolderFromTrash(long folderId, long parentFolderId)
BookmarksFolder	moveFolderToTrash(long folderId)
void	restoreFolderFromTrash(long folderId)
void	subscribeFolder(long groupId, long folderId)
void	unsubscribeFolder(long groupId, long folderId)
BookmarksFolder	updateFolder(long folderId, long parentFolderId, java.lang.String name, java.lang.String description, ServiceContext serviceContext)

Method Detail

addFolder

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

Throws:

PortalException

deleteFolder

void deleteFolder(long folderId)
           throws PortalException

Throws:

PortalException

deleteFolder

void deleteFolder(long folderId,
                  boolean includeTrashedEntries)
           throws PortalException

Throws:

PortalException

getFolder

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

Throws:

PortalException

getFolderIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<java.lang.Long> getFolderIds(long groupId,
                                                                                                               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)

getFoldersAndEntriesCount

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

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)

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getSubfolderIds

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

getSubfolderIds

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

mergeFolders

void mergeFolders(long folderId,
                  long parentFolderId)
           throws PortalException

Throws:

PortalException

moveFolder

BookmarksFolder moveFolder(long folderId,
                           long parentFolderId)
                    throws PortalException

Throws:

PortalException

moveFolderFromTrash

BookmarksFolder moveFolderFromTrash(long folderId,
                                    long parentFolderId)
                             throws PortalException

Throws:

PortalException

moveFolderToTrash

BookmarksFolder moveFolderToTrash(long folderId)
                           throws PortalException

Throws:

PortalException

restoreFolderFromTrash

void restoreFolderFromTrash(long folderId)
                     throws PortalException

Throws:

PortalException

subscribeFolder

void subscribeFolder(long groupId,
                     long folderId)
              throws PortalException

Throws:

PortalException

unsubscribeFolder

void unsubscribeFolder(long groupId,
                       long folderId)
                throws PortalException

Throws:

PortalException

updateFolder

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

Throws:

PortalException