com.liferay.portlet.bookmarks.service.http

Class BookmarksFolderServiceHttp

java.lang.Object

com.liferay.portlet.bookmarks.service.http.BookmarksFolderServiceHttp

public class BookmarksFolderServiceHttp
extends java.lang.Object

Provides the HTTP utility for the BookmarksFolderServiceUtil service utility. The static methods of this class calls the same methods of the service utility. However, the signatures are different because it requires an additional HttpPrincipal parameter.

The benefits of using the HTTP utility is that it is fast and allows for tunneling without the cost of serializing to text. The drawback is that it only works with Java.

Set the property tunnel.servlet.hosts.allowed in portal.properties to configure security.

The HTTP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

BookmarksFolderServiceSoap, HttpPrincipal, BookmarksFolderServiceUtil

Generated:

Constructor Summary

Constructors

Constructor and Description
BookmarksFolderServiceHttp()

Method Summary

Methods

Modifier and Type	Method and Description
static com.liferay.portlet.bookmarks.model.BookmarksFolder	addFolder(HttpPrincipal httpPrincipal, long parentFolderId, java.lang.String name, java.lang.String description, com.liferay.portal.service.ServiceContext serviceContext)
static void	deleteFolder(HttpPrincipal httpPrincipal, long folderId)
static void	deleteFolder(HttpPrincipal httpPrincipal, long folderId, boolean includeTrashedEntries)
static com.liferay.portlet.bookmarks.model.BookmarksFolder	getFolder(HttpPrincipal httpPrincipal, long folderId)
static java.util.List<java.lang.Long>	getFolderIds(HttpPrincipal httpPrincipal, long groupId, long folderId)
static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId)
static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId)
static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int start, int end)
static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder>	getFolders(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int status, int start, int end)
static java.util.List<java.lang.Object>	getFoldersAndEntries(HttpPrincipal httpPrincipal, long groupId, long folderId)
static java.util.List<java.lang.Object>	getFoldersAndEntries(HttpPrincipal httpPrincipal, long groupId, long folderId, int status)
static java.util.List<java.lang.Object>	getFoldersAndEntries(HttpPrincipal httpPrincipal, long groupId, long folderId, int status, int start, int end)
static int	getFoldersAndEntriesCount(HttpPrincipal httpPrincipal, long groupId, long folderId)
static int	getFoldersAndEntriesCount(HttpPrincipal httpPrincipal, long groupId, long folderId, int status)
static int	getFoldersCount(HttpPrincipal httpPrincipal, long groupId, long parentFolderId)
static int	getFoldersCount(HttpPrincipal httpPrincipal, long groupId, long parentFolderId, int status)
static void	getSubfolderIds(HttpPrincipal httpPrincipal, java.util.List<java.lang.Long> folderIds, long groupId, long folderId)
static void	getSubfolderIds(HttpPrincipal httpPrincipal, java.util.List<java.lang.Long> folderIds, long groupId, long folderId, boolean recurse)
static java.util.List<java.lang.Long>	getSubfolderIds(HttpPrincipal httpPrincipal, long groupId, long folderId, boolean recurse)
static com.liferay.portlet.bookmarks.model.BookmarksFolder	moveFolder(HttpPrincipal httpPrincipal, long folderId, long parentFolderId)
static com.liferay.portlet.bookmarks.model.BookmarksFolder	moveFolderFromTrash(HttpPrincipal httpPrincipal, long folderId, long parentFolderId)
static com.liferay.portlet.bookmarks.model.BookmarksFolder	moveFolderToTrash(HttpPrincipal httpPrincipal, long folderId)
static void	restoreFolderFromTrash(HttpPrincipal httpPrincipal, long folderId)
static void	subscribeFolder(HttpPrincipal httpPrincipal, long groupId, long folderId)
static void	unsubscribeFolder(HttpPrincipal httpPrincipal, long groupId, long folderId)
static com.liferay.portlet.bookmarks.model.BookmarksFolder	updateFolder(HttpPrincipal httpPrincipal, long folderId, long parentFolderId, java.lang.String name, java.lang.String description, boolean mergeWithParentFolder, com.liferay.portal.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BookmarksFolderServiceHttp

public BookmarksFolderServiceHttp()

Method Detail

addFolder

public static com.liferay.portlet.bookmarks.model.BookmarksFolder addFolder(HttpPrincipal httpPrincipal,
                                                            long parentFolderId,
                                                            java.lang.String name,
                                                            java.lang.String description,
                                                            com.liferay.portal.service.ServiceContext serviceContext)
                                                                     throws com.liferay.portal.kernel.exception.PortalException,
                                                                            com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deleteFolder

public static void deleteFolder(HttpPrincipal httpPrincipal,
                long folderId)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

deleteFolder

public static void deleteFolder(HttpPrincipal httpPrincipal,
                long folderId,
                boolean includeTrashedEntries)
                         throws com.liferay.portal.kernel.exception.PortalException,
                                com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFolder

public static com.liferay.portlet.bookmarks.model.BookmarksFolder getFolder(HttpPrincipal httpPrincipal,
                                                            long folderId)
                                                                     throws com.liferay.portal.kernel.exception.PortalException,
                                                                            com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFolderIds

public static java.util.List<java.lang.Long> getFolderIds(HttpPrincipal httpPrincipal,
                                          long groupId,
                                          long folderId)
                                                   throws com.liferay.portal.kernel.exception.PortalException,
                                                          com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                             long groupId)
                                                                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                             long groupId,
                                                                             long parentFolderId)
                                                                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                             long groupId,
                                                                             long parentFolderId,
                                                                             int start,
                                                                             int end)
                                                                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFolders

public static java.util.List<com.liferay.portlet.bookmarks.model.BookmarksFolder> getFolders(HttpPrincipal httpPrincipal,
                                                                             long groupId,
                                                                             long parentFolderId,
                                                                             int status,
                                                                             int start,
                                                                             int end)
                                                                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndEntries

public static java.util.List<java.lang.Object> getFoldersAndEntries(HttpPrincipal httpPrincipal,
                                                    long groupId,
                                                    long folderId)
                                                             throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndEntries

public static java.util.List<java.lang.Object> getFoldersAndEntries(HttpPrincipal httpPrincipal,
                                                    long groupId,
                                                    long folderId,
                                                    int status)
                                                             throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndEntries

public static java.util.List<java.lang.Object> getFoldersAndEntries(HttpPrincipal httpPrincipal,
                                                    long groupId,
                                                    long folderId,
                                                    int status,
                                                    int start,
                                                    int end)
                                                             throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndEntriesCount

public static int getFoldersAndEntriesCount(HttpPrincipal httpPrincipal,
                            long groupId,
                            long folderId)
                                     throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersAndEntriesCount

public static int getFoldersAndEntriesCount(HttpPrincipal httpPrincipal,
                            long groupId,
                            long folderId,
                            int status)
                                     throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersCount

public static int getFoldersCount(HttpPrincipal httpPrincipal,
                  long groupId,
                  long parentFolderId)
                           throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getFoldersCount

public static int getFoldersCount(HttpPrincipal httpPrincipal,
                  long groupId,
                  long parentFolderId,
                  int status)
                           throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getSubfolderIds

public static void getSubfolderIds(HttpPrincipal httpPrincipal,
                   java.util.List<java.lang.Long> folderIds,
                   long groupId,
                   long folderId)
                            throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getSubfolderIds

public static void getSubfolderIds(HttpPrincipal httpPrincipal,
                   java.util.List<java.lang.Long> folderIds,
                   long groupId,
                   long folderId,
                   boolean recurse)
                            throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

getSubfolderIds

public static java.util.List<java.lang.Long> getSubfolderIds(HttpPrincipal httpPrincipal,
                                             long groupId,
                                             long folderId,
                                             boolean recurse)
                                                      throws com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.SystemException

moveFolder

public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolder(HttpPrincipal httpPrincipal,
                                                             long folderId,
                                                             long parentFolderId)
                                                                      throws com.liferay.portal.kernel.exception.PortalException,
                                                                             com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

moveFolderFromTrash

public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderFromTrash(HttpPrincipal httpPrincipal,
                                                                      long folderId,
                                                                      long parentFolderId)
                                                                               throws com.liferay.portal.kernel.exception.PortalException,
                                                                                      com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

moveFolderToTrash

public static com.liferay.portlet.bookmarks.model.BookmarksFolder moveFolderToTrash(HttpPrincipal httpPrincipal,
                                                                    long folderId)
                                                                             throws com.liferay.portal.kernel.exception.PortalException,
                                                                                    com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

restoreFolderFromTrash

public static void restoreFolderFromTrash(HttpPrincipal httpPrincipal,
                          long folderId)
                                   throws com.liferay.portal.kernel.exception.PortalException,
                                          com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

subscribeFolder

public static void subscribeFolder(HttpPrincipal httpPrincipal,
                   long groupId,
                   long folderId)
                            throws com.liferay.portal.kernel.exception.PortalException,
                                   com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

unsubscribeFolder

public static void unsubscribeFolder(HttpPrincipal httpPrincipal,
                     long groupId,
                     long folderId)
                              throws com.liferay.portal.kernel.exception.PortalException,
                                     com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException

updateFolder

public static com.liferay.portlet.bookmarks.model.BookmarksFolder updateFolder(HttpPrincipal httpPrincipal,
                                                               long folderId,
                                                               long parentFolderId,
                                                               java.lang.String name,
                                                               java.lang.String description,
                                                               boolean mergeWithParentFolder,
                                                               com.liferay.portal.service.ServiceContext serviceContext)
                                                                        throws com.liferay.portal.kernel.exception.PortalException,
                                                                               com.liferay.portal.kernel.exception.SystemException

Throws:

com.liferay.portal.kernel.exception.PortalException

com.liferay.portal.kernel.exception.SystemException