com.liferay.portlet.documentlibrary.service.http
Class DLFolderServiceSoap

java.lang.Object
  extended by com.liferay.portlet.documentlibrary.service.http.DLFolderServiceSoap

public class DLFolderServiceSoap
extends java.lang.Object

View Source

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

This class provides a SOAP utility for the com.liferay.portlet.documentlibrary.service.DLFolderServiceUtil 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 java.util.List, that is translated to an array of com.liferay.portlet.documentlibrary.model.DLFolderSoap. If the method in the service utility returns a com.liferay.portlet.documentlibrary.model.DLFolder, that is translated to a com.liferay.portlet.documentlibrary.model.DLFolderSoap. 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/tunnel-web/secure/axis. Set the property tunnel.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:
DLFolderSoap, DLFolderServiceUtil, DLFolderServiceHttp

Constructor Summary
DLFolderServiceSoap()
           
 
Method Summary
static com.liferay.portlet.documentlibrary.model.DLFolderSoap addFolder(long groupId, long parentFolderId, java.lang.String name, java.lang.String description, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static com.liferay.portlet.documentlibrary.model.DLFolderSoap addFolder(long groupId, long parentFolderId, java.lang.String name, java.lang.String description, java.lang.String[] communityPermissions, java.lang.String[] guestPermissions)
           
static com.liferay.portlet.documentlibrary.model.DLFolderSoap copyFolder(long groupId, long sourceFolderId, long parentFolderId, java.lang.String name, java.lang.String description, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static void deleteFolder(long folderId)
           
static void deleteFolder(long groupId, long parentFolderId, java.lang.String name)
           
static com.liferay.portlet.documentlibrary.model.DLFolderSoap getFolder(long folderId)
           
static com.liferay.portlet.documentlibrary.model.DLFolderSoap getFolder(long groupId, long parentFolderId, java.lang.String name)
           
static long getFolderId(long groupId, long parentFolderId, java.lang.String name)
           
static com.liferay.portlet.documentlibrary.model.DLFolderSoap[] getFolders(long groupId, long parentFolderId)
           
static boolean hasInheritableLock(long folderId)
           
static com.liferay.lock.model.Lock lockFolder(long folderId)
           
static com.liferay.lock.model.Lock lockFolder(long folderId, java.lang.String owner, boolean inheritable, long expirationTime)
           
static com.liferay.lock.model.Lock refreshFolderLock(java.lang.String lockUuid, long expirationTime)
           
static void reIndexSearch(long companyId)
           
static void unlockFolder(long groupId, long parentFolderId, java.lang.String name, java.lang.String lockUuid)
           
static void unlockFolder(long folderId, java.lang.String lockUuid)
           
static com.liferay.portlet.documentlibrary.model.DLFolderSoap updateFolder(long folderId, long parentFolderId, java.lang.String name, java.lang.String description)
           
static boolean verifyInheritableLock(long folderId, java.lang.String lockUuid)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DLFolderServiceSoap

public DLFolderServiceSoap()
Method Detail

addFolder

public static com.liferay.portlet.documentlibrary.model.DLFolderSoap addFolder(long groupId,
                                                                               long parentFolderId,
                                                                               java.lang.String name,
                                                                               java.lang.String description,
                                                                               boolean addCommunityPermissions,
                                                                               boolean addGuestPermissions)
                                                                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

addFolder

public static com.liferay.portlet.documentlibrary.model.DLFolderSoap addFolder(long groupId,
                                                                               long parentFolderId,
                                                                               java.lang.String name,
                                                                               java.lang.String description,
                                                                               java.lang.String[] communityPermissions,
                                                                               java.lang.String[] guestPermissions)
                                                                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

copyFolder

public static com.liferay.portlet.documentlibrary.model.DLFolderSoap copyFolder(long groupId,
                                                                                long sourceFolderId,
                                                                                long parentFolderId,
                                                                                java.lang.String name,
                                                                                java.lang.String description,
                                                                                boolean addCommunityPermissions,
                                                                                boolean addGuestPermissions)
                                                                         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 groupId,
                                long parentFolderId,
                                java.lang.String name)
                         throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getFolder

public static com.liferay.portlet.documentlibrary.model.DLFolderSoap getFolder(long folderId)
                                                                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getFolder

public static com.liferay.portlet.documentlibrary.model.DLFolderSoap getFolder(long groupId,
                                                                               long parentFolderId,
                                                                               java.lang.String name)
                                                                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getFolderId

public static long getFolderId(long groupId,
                               long parentFolderId,
                               java.lang.String name)
                        throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

getFolders

public static com.liferay.portlet.documentlibrary.model.DLFolderSoap[] getFolders(long groupId,
                                                                                  long parentFolderId)
                                                                           throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

hasInheritableLock

public static boolean hasInheritableLock(long folderId)
                                  throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

lockFolder

public static com.liferay.lock.model.Lock lockFolder(long folderId)
                                              throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

lockFolder

public static com.liferay.lock.model.Lock lockFolder(long folderId,
                                                     java.lang.String owner,
                                                     boolean inheritable,
                                                     long expirationTime)
                                              throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

refreshFolderLock

public static com.liferay.lock.model.Lock refreshFolderLock(java.lang.String lockUuid,
                                                            long expirationTime)
                                                     throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

reIndexSearch

public static void reIndexSearch(long companyId)
                          throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

unlockFolder

public static void unlockFolder(long folderId,
                                java.lang.String lockUuid)
                         throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

unlockFolder

public static void unlockFolder(long groupId,
                                long parentFolderId,
                                java.lang.String name,
                                java.lang.String lockUuid)
                         throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

updateFolder

public static com.liferay.portlet.documentlibrary.model.DLFolderSoap updateFolder(long folderId,
                                                                                  long parentFolderId,
                                                                                  java.lang.String name,
                                                                                  java.lang.String description)
                                                                           throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException

verifyInheritableLock

public static boolean verifyInheritableLock(long folderId,
                                            java.lang.String lockUuid)
                                     throws java.rmi.RemoteException
Throws:
java.rmi.RemoteException