com.liferay.portal.service.http
Class GroupServiceSoap

java.lang.Object
  com.liferay.portal.service.http.GroupServiceSoap

public class GroupServiceSoap
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.portal.service.GroupServiceUtil 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.portal.model.GroupSoap. If the method in the service utility returns a com.liferay.portal.model.Group, that is translated to a com.liferay.portal.model.GroupSoap. 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:

GroupSoap, GroupServiceUtil, GroupServiceHttp

Constructor Summary

GroupServiceSoap()

Method Summary

static com.liferay.portal.model.GroupSoap	addGroup(long liveGroupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active)
static com.liferay.portal.model.GroupSoap	addGroup(java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active)
static void	addRoleGroups(long roleId, long[] groupIds)
static void	deleteGroup(long groupId)
static com.liferay.portal.model.GroupSoap	getGroup(long groupId)
static com.liferay.portal.model.GroupSoap	getGroup(long companyId, java.lang.String name)
static com.liferay.portal.model.GroupSoap[]	getManageableGroups(long userId, java.lang.String actionId)
static com.liferay.portal.model.GroupSoap[]	getOrganizationsGroups(com.liferay.portal.model.OrganizationSoap[] organizations)
static com.liferay.portal.model.GroupSoap	getUserGroup(long companyId, long userId)
static com.liferay.portal.model.GroupSoap[]	getUserGroupsGroups(com.liferay.portal.model.UserGroupSoap[] userGroups)
static com.liferay.portal.model.GroupSoap[]	getUserOrganizationsGroups(long userId, int start, int end)
static boolean	hasUserGroup(long userId, long groupId)
static com.liferay.portal.model.GroupSoap[]	search(long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params, int start, int end)
static int	searchCount(long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params)
static void	setRoleGroups(long roleId, long[] groupIds)
static void	unsetRoleGroups(long roleId, long[] groupIds)
static com.liferay.portal.model.GroupSoap	updateFriendlyURL(long groupId, java.lang.String friendlyURL)
static com.liferay.portal.model.GroupSoap	updateGroup(long groupId, java.lang.String typeSettings)
static com.liferay.portal.model.GroupSoap	updateGroup(long groupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active)
static com.liferay.portal.model.GroupSoap	updateWorkflow(long groupId, boolean workflowEnabled, int workflowStages, java.lang.String workflowRoleNames)

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupServiceSoap

public GroupServiceSoap()

Method Detail

addGroup

public static com.liferay.portal.model.GroupSoap addGroup(java.lang.String name,
                                                          java.lang.String description,
                                                          int type,
                                                          java.lang.String friendlyURL,
                                                          boolean active)
                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

addGroup

public static com.liferay.portal.model.GroupSoap addGroup(long liveGroupId,
                                                          java.lang.String name,
                                                          java.lang.String description,
                                                          int type,
                                                          java.lang.String friendlyURL,
                                                          boolean active)
                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

addRoleGroups

public static void addRoleGroups(long roleId,
                                 long[] groupIds)
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

deleteGroup

public static void deleteGroup(long groupId)
                        throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getGroup

public static com.liferay.portal.model.GroupSoap getGroup(long groupId)
                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getGroup

public static com.liferay.portal.model.GroupSoap getGroup(long companyId,
                                                          java.lang.String name)
                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getManageableGroups

public static com.liferay.portal.model.GroupSoap[] getManageableGroups(long userId,
                                                                       java.lang.String actionId)
                                                                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getOrganizationsGroups

public static com.liferay.portal.model.GroupSoap[] getOrganizationsGroups(com.liferay.portal.model.OrganizationSoap[] organizations)
                                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getUserGroup

public static com.liferay.portal.model.GroupSoap getUserGroup(long companyId,
                                                              long userId)
                                                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getUserGroupsGroups

public static com.liferay.portal.model.GroupSoap[] getUserGroupsGroups(com.liferay.portal.model.UserGroupSoap[] userGroups)
                                                                throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

getUserOrganizationsGroups

public static com.liferay.portal.model.GroupSoap[] getUserOrganizationsGroups(long userId,
                                                                              int start,
                                                                              int end)
                                                                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

hasUserGroup

public static boolean hasUserGroup(long userId,
                                   long groupId)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

search

public static com.liferay.portal.model.GroupSoap[] search(long companyId,
                                                          java.lang.String name,
                                                          java.lang.String description,
                                                          java.lang.String[] params,
                                                          int start,
                                                          int end)
                                                   throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

searchCount

public static int searchCount(long companyId,
                              java.lang.String name,
                              java.lang.String description,
                              java.lang.String[] params)
                       throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

setRoleGroups

public static void setRoleGroups(long roleId,
                                 long[] groupIds)
                          throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

unsetRoleGroups

public static void unsetRoleGroups(long roleId,
                                   long[] groupIds)
                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateFriendlyURL

public static com.liferay.portal.model.GroupSoap updateFriendlyURL(long groupId,
                                                                   java.lang.String friendlyURL)
                                                            throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateGroup

public static com.liferay.portal.model.GroupSoap updateGroup(long groupId,
                                                             java.lang.String name,
                                                             java.lang.String description,
                                                             int type,
                                                             java.lang.String friendlyURL,
                                                             boolean active)
                                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateGroup

public static com.liferay.portal.model.GroupSoap updateGroup(long groupId,
                                                             java.lang.String typeSettings)
                                                      throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException

updateWorkflow

public static com.liferay.portal.model.GroupSoap updateWorkflow(long groupId,
                                                                boolean workflowEnabled,
                                                                int workflowStages,
                                                                java.lang.String workflowRoleNames)
                                                         throws java.rmi.RemoteException

Throws:

java.rmi.RemoteException