Liferay 6.1.2-ce-ga3

com.liferay.portal.service.http
Class GroupServiceSoap

java.lang.Object
  extended by 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/api/secure/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:
GroupServiceHttp, GroupSoap, GroupServiceUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
GroupServiceSoap()
           
 
Method Summary
static GroupSoap addGroup(long liveGroupId, String name, String description, int type, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)
          Adds a group.
static GroupSoap addGroup(String name, String description, int type, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)
          Adds the group using the group default live group ID.
static void addRoleGroups(long roleId, long[] groupIds)
          Adds the groups to the role.
static void deleteGroup(long groupId)
          Deletes the group.
static GroupSoap getGroup(long groupId)
          Returns the group with the primary key.
static GroupSoap getGroup(long companyId, String name)
          Returns the group with the name.
static GroupSoap[] getManageableSites(Collection<Portlet> portlets, int max)
          Returns a range of all the site groups for which the user has control panel access.
static GroupSoap[] getOrganizationsGroups(OrganizationSoap[] organizations)
          Returns the groups associated with the organizations.
static GroupSoap getUserGroup(long companyId, long userId)
          Returns the group associated with the user.
static GroupSoap[] getUserGroupsGroups(UserGroupSoap[] userGroups)
          Returns the groups associated with the user groups.
static GroupSoap[] getUserOrganizationsGroups(long userId, int start, int end)
          Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to true.
static GroupSoap[] getUserPlaces(long userId, String[] classNames, boolean includeControlPanel, int max)
           
static GroupSoap[] getUserPlaces(long userId, String[] classNames, int max)
          Returns the user's group "places" associated with the group entity class names, including the control panel group if the user is permitted to view the control panel.
static GroupSoap[] getUserPlaces(String[] classNames, int max)
          Returns the guest or current user's group "places" associated with the group entity class names, including the control panel group if the user is permitted to view the control panel.
static GroupSoap[] getUserSites()
          Returns the guest or current user's layout set group, organization groups, inherited organization groups, and site groups.
static boolean hasUserGroup(long userId, long groupId)
          Returns true if the user is associated with the group, including the user's inherited organizations and user groups.
static GroupSoap[] search(long companyId, String name, String description, String[] params, int start, int end)
          Returns a name ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups.
static int searchCount(long companyId, String name, String description, String[] params)
          Returns the number of groups and organization groups that match the name and description, optionally including the user's inherited organizations and user groups.
static void setRoleGroups(long roleId, long[] groupIds)
          Sets the groups associated with the role, removing and adding associations as necessary.
static void unsetRoleGroups(long roleId, long[] groupIds)
          Removes the groups from the role.
static GroupSoap updateFriendlyURL(long groupId, String friendlyURL)
          Updates the group's friendly URL.
static GroupSoap updateGroup(long groupId, String typeSettings)
          Updates the group's type settings.
static GroupSoap updateGroup(long groupId, String name, String description, int type, String friendlyURL, boolean active, ServiceContext serviceContext)
          Updates the group.
 
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 GroupSoap addGroup(long liveGroupId,
                                 String name,
                                 String description,
                                 int type,
                                 String friendlyURL,
                                 boolean site,
                                 boolean active,
                                 ServiceContext serviceContext)
                          throws RemoteException
Adds a group.

Parameters:
liveGroupId - the primary key of the live group
name - the entity's name
description - the group's description (optionally null)
type - the group's type. For more information see GroupConstants
friendlyURL - the group's friendlyURL (optionally null)
site - whether the group is to be associated with a main site
active - whether the group is active
serviceContext - the service context to be applied (optionally null). Can set the asset category IDs and asset tag names for the group, and can set whether the group is for staging
Returns:
the group
Throws:
PortalException - if the user did not have permission to add the group, if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group
SystemException - if a system exception occurred
RemoteException

addGroup

public static GroupSoap addGroup(String name,
                                 String description,
                                 int type,
                                 String friendlyURL,
                                 boolean site,
                                 boolean active,
                                 ServiceContext serviceContext)
                          throws RemoteException
Adds the group using the group default live group ID.

Parameters:
name - the entity's name
description - the group's description (optionally null)
type - the group's type. For more information see GroupConstants
friendlyURL - the group's friendlyURL
site - whether the group is to be associated with a main site
active - whether the group is active
serviceContext - the service context to be applied (optionally null). Can set asset category IDs and asset tag names for the group, and can set whether the group is for staging
Returns:
the group
Throws:
PortalException - if the user did not have permission to add the group, if a creator could not be found, if the group's information was invalid, if a layout could not be found, or if a valid friendly URL could not be created for the group
SystemException - if a system exception occurred
RemoteException

addRoleGroups

public static void addRoleGroups(long roleId,
                                 long[] groupIds)
                          throws RemoteException
Adds the groups to the role.

Parameters:
roleId - the primary key of the role
groupIds - the primary keys of the groups
Throws:
PortalException - if the user did not have permission to update the role
SystemException - if a system exception occurred
RemoteException

deleteGroup

public static void deleteGroup(long groupId)
                        throws RemoteException
Deletes the group.

The group is unstaged and its assets and resources including layouts, membership requests, subscriptions, teams, blogs, bookmarks, calendar events, image gallery, journals, message boards, polls, shopping related entities, software catalog, and wikis are also deleted.

Parameters:
groupId - the primary key of the group
Throws:
PortalException - if the user did not have permission to delete the group or its assets or resources, if a group with the primary key could not be found, or if the group was a system group
SystemException - if a system exception occurred
RemoteException

getGroup

public static GroupSoap getGroup(long groupId)
                          throws RemoteException
Returns the group with the primary key.

Parameters:
groupId - the primary key of the group
Returns:
the group with the primary key
Throws:
PortalException - if a group with the primary key could not be found or if the current user did not have permission to view the group
SystemException - if a system exception occurred
RemoteException

getGroup

public static GroupSoap getGroup(long companyId,
                                 String name)
                          throws RemoteException
Returns the group with the name.

Parameters:
companyId - the primary key of the company
name - the group's name
Returns:
the group with the name
Throws:
PortalException - if a matching group could not be found or if the current user did not have permission to view the group
SystemException - if a system exception occurred
RemoteException

getManageableSites

public static GroupSoap[] getManageableSites(Collection<Portlet> portlets,
                                             int max)
                                      throws RemoteException
Returns a range of all the site groups for which the user has control panel access.

Parameters:
portlets - the portlets to manage
max - the upper bound of the range of groups to consider (not inclusive)
Returns:
the range of site groups for which the user has control panel access
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
RemoteException

getOrganizationsGroups

public static GroupSoap[] getOrganizationsGroups(OrganizationSoap[] organizations)
                                          throws RemoteException
Returns the groups associated with the organizations.

Parameters:
organizations - the organizations
Returns:
the groups associated with the organizations
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
RemoteException

getUserGroup

public static GroupSoap getUserGroup(long companyId,
                                     long userId)
                              throws RemoteException
Returns the group associated with the user.

Parameters:
companyId - the primary key of the company
userId - the primary key of the user
Returns:
the group associated with the user
Throws:
PortalException - if a matching group could not be found or if the current user did not have permission to view the group
SystemException - if a system exception occurred
RemoteException

getUserGroupsGroups

public static GroupSoap[] getUserGroupsGroups(UserGroupSoap[] userGroups)
                                       throws RemoteException
Returns the groups associated with the user groups.

Parameters:
userGroups - the user groups
Returns:
the groups associated with the user groups
Throws:
PortalException - if any one of the user group's group could not be found
SystemException - if a system exception occurred
RemoteException

getUserOrganizationsGroups

public static GroupSoap[] getUserOrganizationsGroups(long userId,
                                                     int start,
                                                     int end)
                                              throws RemoteException
Returns the range of all groups associated with the user's organization groups, including the ancestors of the organization groups, unless portal property organizations.membership.strict is set to true.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
userId - the primary key of the user
start - the lower bound of the range of groups to consider
end - the upper bound of the range of groups to consider (not inclusive)
Returns:
the range of groups associated with the user's organizations
Throws:
PortalException - if a user with the primary key could not be found or if another portal exception occurred
SystemException - if a system exception occurred
RemoteException

getUserPlaces

public static GroupSoap[] getUserPlaces(long userId,
                                        String[] classNames,
                                        boolean includeControlPanel,
                                        int max)
                                 throws RemoteException
Throws:
RemoteException

getUserPlaces

public static GroupSoap[] getUserPlaces(long userId,
                                        String[] classNames,
                                        int max)
                                 throws RemoteException
Returns the user's group "places" associated with the group entity class names, including the control panel group if the user is permitted to view the control panel.

Parameters:
userId - the primary key of the user
classNames - the group entity class names (optionally null). For more information see getUserPlaces(long, String[], int)
max - the maximum number of groups to return
Returns:
the user's group "places"
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
RemoteException

getUserPlaces

public static GroupSoap[] getUserPlaces(String[] classNames,
                                        int max)
                                 throws RemoteException
Returns the guest or current user's group "places" associated with the group entity class names, including the control panel group if the user is permitted to view the control panel.

Parameters:
classNames - the group entity class names (optionally null). For more information see getUserPlaces(String[], int)
max - the maximum number of groups to return
Returns:
the user's group "places"
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
RemoteException

getUserSites

public static GroupSoap[] getUserSites()
                                throws RemoteException
Returns the guest or current user's layout set group, organization groups, inherited organization groups, and site groups.

Returns:
the user's layout set group, organization groups, and inherited organization groups, and site groups
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
RemoteException

hasUserGroup

public static boolean hasUserGroup(long userId,
                                   long groupId)
                            throws RemoteException
Returns true if the user is associated with the group, including the user's inherited organizations and user groups. System and staged groups are not included.

Parameters:
userId - the primary key of the user
groupId - the primary key of the group
Returns:
true if the user is associated with the group; false otherwise
Throws:
PortalException - if the current user did not have permission to view the user or group members
SystemException - if a system exception occurred
RemoteException

search

public static GroupSoap[] search(long companyId,
                                 String name,
                                 String description,
                                 String[] params,
                                 int start,
                                 int end)
                          throws RemoteException
Returns a name ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. System and staged groups are not included.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the primary key of the company
name - the group's name (optionally null)
description - the group's description (optionally null)
params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
start - the lower bound of the range of groups to return
end - the upper bound of the range of groups to return (not inclusive)
Returns:
the matching groups ordered by name
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred
RemoteException

searchCount

public static int searchCount(long companyId,
                              String name,
                              String description,
                              String[] params)
                       throws RemoteException
Returns the number of groups and organization groups that match the name and description, optionally including the user's inherited organizations and user groups. System and staged groups are not included.

Parameters:
companyId - the primary key of the company
name - the group's name (optionally null)
description - the group's description (optionally null)
params - the finder params (optionally null). To include the user's inherited organizations and user groups in the search, add entries having "usersGroups" and "inherit" as keys mapped to the the user's ID. For more information see GroupFinder
Returns:
the number of matching groups
Throws:
SystemException - if a system exception occurred
RemoteException

setRoleGroups

public static void setRoleGroups(long roleId,
                                 long[] groupIds)
                          throws RemoteException
Sets the groups associated with the role, removing and adding associations as necessary.

Parameters:
roleId - the primary key of the role
groupIds - the primary keys of the groups
Throws:
PortalException - if the user did not have permission to update update the role
SystemException - if a system exception occurred
RemoteException

unsetRoleGroups

public static void unsetRoleGroups(long roleId,
                                   long[] groupIds)
                            throws RemoteException
Removes the groups from the role.

Parameters:
roleId - the primary key of the role
groupIds - the primary keys of the groups
Throws:
PortalException - if the user did not have permission to update the role
SystemException - if a system exception occurred
RemoteException

updateFriendlyURL

public static GroupSoap updateFriendlyURL(long groupId,
                                          String friendlyURL)
                                   throws RemoteException
Updates the group's friendly URL.

Parameters:
groupId - the primary key of the group
friendlyURL - the group's new friendlyURL (optionally null)
Returns:
the group
Throws:
PortalException - if the user did not have permission to update the group, if a group with the primary key could not be found, or if a valid friendly URL could not be created for the group
SystemException - if a system exception occurred
RemoteException

updateGroup

public static GroupSoap updateGroup(long groupId,
                                    String typeSettings)
                             throws RemoteException
Updates the group's type settings.

Parameters:
groupId - the primary key of the group
typeSettings - the group's new type settings (optionally null)
Returns:
the group
Throws:
PortalException - if the user did not have permission to update the group or if a group with the primary key could not be found
SystemException - if a system exception occurred
RemoteException

updateGroup

public static GroupSoap updateGroup(long groupId,
                                    String name,
                                    String description,
                                    int type,
                                    String friendlyURL,
                                    boolean active,
                                    ServiceContext serviceContext)
                             throws RemoteException
Updates the group.

Parameters:
groupId - the primary key of the group
name - the group's new name
description - the group's new description (optionally null)
type - the group's new type. For more information see GroupConstants
friendlyURL - the group's new friendlyURL (optionally null)
active - whether the group is active
serviceContext - the service context to be applied (optionally null). Can set the asset category IDs and asset tag names for the group.
Returns:
the group
Throws:
PortalException - if the user did not have permission to update the group, if a group with the primary key could not be found, if the friendly URL was invalid or could one not be created
SystemException - if a system exception occurred
RemoteException

Liferay 6.1.2-ce-ga3