com.liferay.portlet.bookmarks.service.http

Class BookmarksFolderServiceSoap

java.lang.Object

com.liferay.portlet.bookmarks.service.http.BookmarksFolderServiceSoap

@ProviderType
public class BookmarksFolderServiceSoap
extends java.lang.Object

Provides the SOAP 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 is difficult for SOAP to support certain types.

ServiceBuilder follows certain rules in translating the methods. For example, if the method in the service utility returns a List, that is translated to an array of BookmarksFolderSoap. If the method in the service utility returns a BookmarksFolder, that is translated to a BookmarksFolderSoap. Methods that SOAP cannot safely wire are skipped.

The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).

You can see a list of services at http://localhost:8080/api/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.

The SOAP utility is only generated for remote services.

Author:

Brian Wing Shun Chan

See Also:

BookmarksFolderServiceHttp, BookmarksFolderSoap, BookmarksFolderServiceUtil

Generated:

Constructor Summary

Constructors

Constructor and Description
BookmarksFolderServiceSoap()

Method Summary

Methods

Modifier and Type	Method and Description
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap	addFolder(long parentFolderId, java.lang.String name, java.lang.String description, com.liferay.portal.service.ServiceContext serviceContext)
static void	deleteFolder(long folderId)
static void	deleteFolder(long folderId, boolean includeTrashedEntries)
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap	getFolder(long folderId)
static java.lang.Long[]	getFolderIds(long groupId, long folderId)
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap[]	getFolders(long groupId)
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap[]	getFolders(long groupId, long parentFolderId)
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap[]	getFolders(long groupId, long parentFolderId, int start, int end)
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap[]	getFolders(long groupId, long parentFolderId, int status, int start, int end)
static int	getFoldersAndEntriesCount(long groupId, long folderId)
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 void	getSubfolderIds(java.lang.Long[] folderIds, long groupId, long folderId) Deprecated. As of 7.0.0, replaced by #getSubfolderIds(List, long, long, boolean)
static void	getSubfolderIds(java.lang.Long[] folderIds, long groupId, long folderId, boolean recurse)
static java.lang.Long[]	getSubfolderIds(long groupId, long folderId, boolean recurse)
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap	moveFolder(long folderId, long parentFolderId)
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap	moveFolderFromTrash(long folderId, long parentFolderId)
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap	moveFolderToTrash(long folderId)
static void	restoreFolderFromTrash(long folderId)
static void	subscribeFolder(long groupId, long folderId)
static void	unsubscribeFolder(long groupId, long folderId)
static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap	updateFolder(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

BookmarksFolderServiceSoap

public BookmarksFolderServiceSoap()

Method Detail

addFolder

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap addFolder(long parentFolderId,
                                                                java.lang.String name,
                                                                java.lang.String description,
                                                                com.liferay.portal.service.ServiceContext serviceContext)
                                                                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

deleteFolder

public static void deleteFolder(long folderId)
                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

deleteFolder

public static void deleteFolder(long folderId,
                boolean includeTrashedEntries)
                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFolder

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap getFolder(long folderId)
                                                                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFolderIds

public static java.lang.Long[] getFolderIds(long groupId,
                            long folderId)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFolders

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap[] getFolders(long groupId)
                                                                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFolders

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap[] getFolders(long groupId,
                                                                   long parentFolderId)
                                                                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFolders

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap[] getFolders(long groupId,
                                                                   long parentFolderId,
                                                                   int start,
                                                                   int end)
                                                                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFolders

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap[] getFolders(long groupId,
                                                                   long parentFolderId,
                                                                   int status,
                                                                   int start,
                                                                   int end)
                                                                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFoldersAndEntriesCount

public static int getFoldersAndEntriesCount(long groupId,
                            long folderId)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFoldersAndEntriesCount

public static int getFoldersAndEntriesCount(long groupId,
                            long folderId,
                            int status)
                                     throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFoldersCount

public static int getFoldersCount(long groupId,
                  long parentFolderId)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getFoldersCount

public static int getFoldersCount(long groupId,
                  long parentFolderId,
                  int status)
                           throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSubfolderIds

@Deprecated
public static void getSubfolderIds(java.lang.Long[] folderIds,
                              long groupId,
                              long folderId)
                            throws java.rmi.RemoteException

Deprecated. As of 7.0.0, replaced by #getSubfolderIds(List, long, long, boolean)

Throws:

java.rmi.RemoteException

getSubfolderIds

public static void getSubfolderIds(java.lang.Long[] folderIds,
                   long groupId,
                   long folderId,
                   boolean recurse)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getSubfolderIds

public static java.lang.Long[] getSubfolderIds(long groupId,
                               long folderId,
                               boolean recurse)
                                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

moveFolder

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap moveFolder(long folderId,
                                                                 long parentFolderId)
                                                                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

moveFolderFromTrash

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap moveFolderFromTrash(long folderId,
                                                                          long parentFolderId)
                                                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

moveFolderToTrash

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap moveFolderToTrash(long folderId)
                                                                                 throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

restoreFolderFromTrash

public static void restoreFolderFromTrash(long folderId)
                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

subscribeFolder

public static void subscribeFolder(long groupId,
                   long folderId)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

unsubscribeFolder

public static void unsubscribeFolder(long groupId,
                     long folderId)
                              throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateFolder

public static com.liferay.portlet.bookmarks.model.BookmarksFolderSoap updateFolder(long folderId,
                                                                   long parentFolderId,
                                                                   java.lang.String name,
                                                                   java.lang.String description,
                                                                   boolean mergeWithParentFolder,
                                                                   com.liferay.portal.service.ServiceContext serviceContext)
                                                                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException