Liferay 6.0.5

com.liferay.portal.service.http
Class UserGroupServiceSoap

java.lang.Object
  extended by com.liferay.portal.service.http.UserGroupServiceSoap

public class UserGroupServiceSoap
extends Object

This class provides a SOAP utility for the UserGroupServiceUtil 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 UserGroupSoap. If the method in the service utility returns a UserGroup, that is translated to a UserGroupSoap. 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.

See Also:
UserGroupServiceHttp, UserGroupSoap, UserGroupServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
UserGroupServiceSoap()
           
 
Method Summary
static void addGroupUserGroups(long groupId, long[] userGroupIds)
           
static UserGroupSoap addUserGroup(String name, String description)
           
static void deleteUserGroup(long userGroupId)
           
static UserGroupSoap getUserGroup(long userGroupId)
           
static UserGroupSoap getUserGroup(String name)
           
static UserGroupSoap[] getUserUserGroups(long userId)
           
static void unsetGroupUserGroups(long groupId, long[] userGroupIds)
           
static UserGroupSoap updateUserGroup(long userGroupId, String name, String description)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

UserGroupServiceSoap

public UserGroupServiceSoap()
Method Detail

addGroupUserGroups

public static void addGroupUserGroups(long groupId,
                                      long[] userGroupIds)
                               throws RemoteException
Throws:
RemoteException

addUserGroup

public static UserGroupSoap addUserGroup(String name,
                                         String description)
                                  throws RemoteException
Throws:
RemoteException

deleteUserGroup

public static void deleteUserGroup(long userGroupId)
                            throws RemoteException
Throws:
RemoteException

getUserGroup

public static UserGroupSoap getUserGroup(long userGroupId)
                                  throws RemoteException
Throws:
RemoteException

getUserGroup

public static UserGroupSoap getUserGroup(String name)
                                  throws RemoteException
Throws:
RemoteException

getUserUserGroups

public static UserGroupSoap[] getUserUserGroups(long userId)
                                         throws RemoteException
Throws:
RemoteException

unsetGroupUserGroups

public static void unsetGroupUserGroups(long groupId,
                                        long[] userGroupIds)
                                 throws RemoteException
Throws:
RemoteException

updateUserGroup

public static UserGroupSoap updateUserGroup(long userGroupId,
                                            String name,
                                            String description)
                                     throws RemoteException
Throws:
RemoteException

Liferay 6.0.5