com.liferay.portal.service.http
Class GroupServiceSoap
java.lang.Object
com.liferay.portal.service.http.GroupServiceSoap
public class GroupServiceSoap
- extends Object
This class provides a SOAP utility for the
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 List
, that
is translated to an array of GroupSoap
.
If the method in the service utility returns a
Group
, that is translated to a
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.
- See Also:
GroupServiceHttp
,
GroupSoap
,
GroupServiceUtil
- ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.
Method Summary |
static GroupSoap |
addGroup(long liveGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
|
static GroupSoap |
addGroup(String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
|
static void |
addRoleGroups(long roleId,
long[] groupIds)
|
static void |
deleteGroup(long groupId)
|
static GroupSoap |
getGroup(long groupId)
|
static GroupSoap |
getGroup(long companyId,
String name)
|
static GroupSoap[] |
getManageableGroups(String actionId,
int max)
|
static GroupSoap[] |
getOrganizationsGroups(OrganizationSoap[] organizations)
|
static GroupSoap |
getUserGroup(long companyId,
long userId)
|
static GroupSoap[] |
getUserGroupsGroups(UserGroupSoap[] userGroups)
|
static GroupSoap[] |
getUserOrganizationsGroups(long userId,
int start,
int end)
|
static boolean |
hasUserGroup(long userId,
long groupId)
|
static GroupSoap[] |
search(long companyId,
String name,
String description,
String[] params,
int start,
int end)
|
static int |
searchCount(long companyId,
String name,
String description,
String[] params)
|
static void |
setRoleGroups(long roleId,
long[] groupIds)
|
static void |
unsetRoleGroups(long roleId,
long[] groupIds)
|
static GroupSoap |
updateFriendlyURL(long groupId,
String friendlyURL)
|
static GroupSoap |
updateGroup(long groupId,
String typeSettings)
|
static GroupSoap |
updateGroup(long groupId,
String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
|
static GroupSoap |
updateWorkflow(long groupId,
boolean workflowEnabled,
int workflowStages,
String workflowRoleNames)
|
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
GroupServiceSoap
public GroupServiceSoap()
addGroup
public static GroupSoap addGroup(String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
throws RemoteException
- Throws:
RemoteException
addGroup
public static GroupSoap addGroup(long liveGroupId,
String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
throws RemoteException
- Throws:
RemoteException
addRoleGroups
public static void addRoleGroups(long roleId,
long[] groupIds)
throws RemoteException
- Throws:
RemoteException
deleteGroup
public static void deleteGroup(long groupId)
throws RemoteException
- Throws:
RemoteException
getGroup
public static GroupSoap getGroup(long groupId)
throws RemoteException
- Throws:
RemoteException
getGroup
public static GroupSoap getGroup(long companyId,
String name)
throws RemoteException
- Throws:
RemoteException
getManageableGroups
public static GroupSoap[] getManageableGroups(String actionId,
int max)
throws RemoteException
- Throws:
RemoteException
getOrganizationsGroups
public static GroupSoap[] getOrganizationsGroups(OrganizationSoap[] organizations)
throws RemoteException
- Throws:
RemoteException
getUserGroup
public static GroupSoap getUserGroup(long companyId,
long userId)
throws RemoteException
- Throws:
RemoteException
getUserGroupsGroups
public static GroupSoap[] getUserGroupsGroups(UserGroupSoap[] userGroups)
throws RemoteException
- Throws:
RemoteException
getUserOrganizationsGroups
public static GroupSoap[] getUserOrganizationsGroups(long userId,
int start,
int end)
throws RemoteException
- Throws:
RemoteException
hasUserGroup
public static boolean hasUserGroup(long userId,
long groupId)
throws RemoteException
- Throws:
RemoteException
search
public static GroupSoap[] search(long companyId,
String name,
String description,
String[] params,
int start,
int end)
throws RemoteException
- Throws:
RemoteException
searchCount
public static int searchCount(long companyId,
String name,
String description,
String[] params)
throws RemoteException
- Throws:
RemoteException
setRoleGroups
public static void setRoleGroups(long roleId,
long[] groupIds)
throws RemoteException
- Throws:
RemoteException
unsetRoleGroups
public static void unsetRoleGroups(long roleId,
long[] groupIds)
throws RemoteException
- Throws:
RemoteException
updateFriendlyURL
public static GroupSoap updateFriendlyURL(long groupId,
String friendlyURL)
throws RemoteException
- Throws:
RemoteException
updateGroup
public static GroupSoap updateGroup(long groupId,
String name,
String description,
int type,
String friendlyURL,
boolean active,
ServiceContext serviceContext)
throws RemoteException
- Throws:
RemoteException
updateGroup
public static GroupSoap updateGroup(long groupId,
String typeSettings)
throws RemoteException
- Throws:
RemoteException
updateWorkflow
public static GroupSoap updateWorkflow(long groupId,
boolean workflowEnabled,
int workflowStages,
String workflowRoleNames)
throws RemoteException
- Throws:
RemoteException