Liferay 6.2-ce-ga5

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

java.lang.Object
  extended by com.liferay.portlet.bookmarks.service.http.BookmarksFolderServiceSoap

@ProviderType
public class BookmarksFolderServiceSoap
extends 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.

See Also:
BookmarksFolderServiceHttp, BookmarksFolderSoap, BookmarksFolderServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
BookmarksFolderServiceSoap()
           
 
Method Summary
static BookmarksFolderSoap addFolder(long parentFolderId, String name, String description, ServiceContext serviceContext)
           
static void deleteFolder(long folderId)
           
static void deleteFolder(long folderId, boolean includeTrashedEntries)
           
static BookmarksFolderSoap getFolder(long folderId)
           
static Long[] getFolderIds(long groupId, long folderId)
           
static BookmarksFolderSoap[] getFolders(long groupId)
           
static BookmarksFolderSoap[] getFolders(long groupId, long parentFolderId)
           
static BookmarksFolderSoap[] getFolders(long groupId, long parentFolderId, int start, int end)
           
static 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(Long[] folderIds, long groupId, long folderId)
          Deprecated. As of 7.0.0, replaced by #getSubfolderIds(List, long, long, boolean)
static void getSubfolderIds(Long[] folderIds, long groupId, long folderId, boolean recurse)
           
static Long[] getSubfolderIds(long groupId, long folderId, boolean recurse)
           
static BookmarksFolderSoap moveFolder(long folderId, long parentFolderId)
           
static BookmarksFolderSoap moveFolderFromTrash(long folderId, long parentFolderId)
           
static BookmarksFolderSoap moveFolderToTrash(long folderId)
           
static void restoreFolderFromTrash(long folderId)
           
static void subscribeFolder(long groupId, long folderId)
           
static void unsubscribeFolder(long groupId, long folderId)
           
static BookmarksFolderSoap updateFolder(long folderId, long parentFolderId, String name, String description, boolean mergeWithParentFolder, 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 BookmarksFolderSoap addFolder(long parentFolderId,
                                            String name,
                                            String description,
                                            ServiceContext serviceContext)
                                     throws RemoteException
Throws:
RemoteException

deleteFolder

public static void deleteFolder(long folderId)
                         throws RemoteException
Throws:
RemoteException

deleteFolder

public static void deleteFolder(long folderId,
                                boolean includeTrashedEntries)
                         throws RemoteException
Throws:
RemoteException

getFolder

public static BookmarksFolderSoap getFolder(long folderId)
                                     throws RemoteException
Throws:
RemoteException

getFolderIds

public static Long[] getFolderIds(long groupId,
                                  long folderId)
                           throws RemoteException
Throws:
RemoteException

getFolders

public static BookmarksFolderSoap[] getFolders(long groupId)
                                        throws RemoteException
Throws:
RemoteException

getFolders

public static BookmarksFolderSoap[] getFolders(long groupId,
                                               long parentFolderId)
                                        throws RemoteException
Throws:
RemoteException

getFolders

public static BookmarksFolderSoap[] getFolders(long groupId,
                                               long parentFolderId,
                                               int start,
                                               int end)
                                        throws RemoteException
Throws:
RemoteException

getFolders

public static BookmarksFolderSoap[] getFolders(long groupId,
                                               long parentFolderId,
                                               int status,
                                               int start,
                                               int end)
                                        throws RemoteException
Throws:
RemoteException

getFoldersAndEntriesCount

public static int getFoldersAndEntriesCount(long groupId,
                                            long folderId)
                                     throws RemoteException
Throws:
RemoteException

getFoldersAndEntriesCount

public static int getFoldersAndEntriesCount(long groupId,
                                            long folderId,
                                            int status)
                                     throws RemoteException
Throws:
RemoteException

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId)
                           throws RemoteException
Throws:
RemoteException

getFoldersCount

public static int getFoldersCount(long groupId,
                                  long parentFolderId,
                                  int status)
                           throws RemoteException
Throws:
RemoteException

getSubfolderIds

@Deprecated
public static void getSubfolderIds(Long[] folderIds,
                                              long groupId,
                                              long folderId)
                            throws RemoteException
Deprecated. As of 7.0.0, replaced by #getSubfolderIds(List, long, long, boolean)

Throws:
RemoteException

getSubfolderIds

public static void getSubfolderIds(Long[] folderIds,
                                   long groupId,
                                   long folderId,
                                   boolean recurse)
                            throws RemoteException
Throws:
RemoteException

getSubfolderIds

public static Long[] getSubfolderIds(long groupId,
                                     long folderId,
                                     boolean recurse)
                              throws RemoteException
Throws:
RemoteException

moveFolder

public static BookmarksFolderSoap moveFolder(long folderId,
                                             long parentFolderId)
                                      throws RemoteException
Throws:
RemoteException

moveFolderFromTrash

public static BookmarksFolderSoap moveFolderFromTrash(long folderId,
                                                      long parentFolderId)
                                               throws RemoteException
Throws:
RemoteException

moveFolderToTrash

public static BookmarksFolderSoap moveFolderToTrash(long folderId)
                                             throws RemoteException
Throws:
RemoteException

restoreFolderFromTrash

public static void restoreFolderFromTrash(long folderId)
                                   throws RemoteException
Throws:
RemoteException

subscribeFolder

public static void subscribeFolder(long groupId,
                                   long folderId)
                            throws RemoteException
Throws:
RemoteException

unsubscribeFolder

public static void unsubscribeFolder(long groupId,
                                     long folderId)
                              throws RemoteException
Throws:
RemoteException

updateFolder

public static BookmarksFolderSoap updateFolder(long folderId,
                                               long parentFolderId,
                                               String name,
                                               String description,
                                               boolean mergeWithParentFolder,
                                               ServiceContext serviceContext)
                                        throws RemoteException
Throws:
RemoteException

Liferay 6.2-ce-ga5