Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Class GroupServiceWrapper

java.lang.Object
  extended by com.liferay.portal.service.GroupServiceWrapper
All Implemented Interfaces:
BaseService, GroupService, ServiceWrapper<GroupService>

public class GroupServiceWrapper
extends Object
implements GroupService, ServiceWrapper<GroupService>

This class is a wrapper for GroupService.

See Also:
GroupService
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
GroupServiceWrapper(GroupService groupService)
           
 
Method Summary
 Group addGroup(long liveGroupId, String name, String description, int type, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)
          Adds a group.
 Group 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.
 void addRoleGroups(long roleId, long[] groupIds)
          Adds the groups to the role.
 void deleteGroup(long groupId)
          Deletes the group.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 Group getGroup(long groupId)
          Returns the group with the primary key.
 Group getGroup(long companyId, String name)
          Returns the group with the name.
 List<Group> getManageableSites(Collection<Portlet> portlets, int max)
          Returns a range of all the site groups for which the user has control panel access.
 List<Group> getOrganizationsGroups(List<Organization> organizations)
          Returns the groups associated with the organizations.
 Group getUserGroup(long companyId, long userId)
          Returns the group associated with the user.
 List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
          Returns the groups associated with the user groups.
 List<Group> 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.
 List<Group> getUserPlaces(long userId, String[] classNames, boolean includeControlPanel, int max)
           
 List<Group> 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.
 List<Group> 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.
 List<Group> getUserSites()
          Returns the guest or current user's layout set group, organization groups, inherited organization groups, and site groups.
 GroupService getWrappedGroupService()
          Deprecated. Renamed to getWrappedService()
 GroupService getWrappedService()
           
 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.
 List<Group> 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.
 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.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setRoleGroups(long roleId, long[] groupIds)
          Sets the groups associated with the role, removing and adding associations as necessary.
 void setWrappedGroupService(GroupService groupService)
          Deprecated. Renamed to setWrappedService(com.liferay.portal.service.GroupService)
 void setWrappedService(GroupService groupService)
           
 void unsetRoleGroups(long roleId, long[] groupIds)
          Removes the groups from the role.
 Group updateFriendlyURL(long groupId, String friendlyURL)
          Updates the group's friendly URL.
 Group updateGroup(long groupId, String typeSettings)
          Updates the group's type settings.
 Group 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

GroupServiceWrapper

public GroupServiceWrapper(GroupService groupService)
Method Detail

getBeanIdentifier

public String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Specified by:
getBeanIdentifier in interface GroupService
Returns:
the Spring bean ID for this bean

setBeanIdentifier

public void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Specified by:
setBeanIdentifier in interface GroupService
Parameters:
beanIdentifier - the Spring bean ID for this bean

addGroup

public Group addGroup(long liveGroupId,
                      String name,
                      String description,
                      int type,
                      String friendlyURL,
                      boolean site,
                      boolean active,
                      ServiceContext serviceContext)
               throws PortalException,
                      SystemException
Adds a group.

Specified by:
addGroup in interface GroupService
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

addGroup

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

Specified by:
addGroup in interface GroupService
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

addRoleGroups

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

Specified by:
addRoleGroups in interface GroupService
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

deleteGroup

public void deleteGroup(long groupId)
                 throws PortalException,
                        SystemException
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.

Specified by:
deleteGroup in interface GroupService
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

getGroup

public Group getGroup(long groupId)
               throws PortalException,
                      SystemException
Returns the group with the primary key.

Specified by:
getGroup in interface GroupService
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

getGroup

public Group getGroup(long companyId,
                      String name)
               throws PortalException,
                      SystemException
Returns the group with the name.

Specified by:
getGroup in interface GroupService
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

getManageableSites

public List<Group> getManageableSites(Collection<Portlet> portlets,
                                      int max)
                               throws PortalException,
                                      SystemException
Returns a range of all the site groups for which the user has control panel access.

Specified by:
getManageableSites in interface GroupService
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

getOrganizationsGroups

public List<Group> getOrganizationsGroups(List<Organization> organizations)
                                   throws PortalException,
                                          SystemException
Returns the groups associated with the organizations.

Specified by:
getOrganizationsGroups in interface GroupService
Parameters:
organizations - the organizations
Returns:
the groups associated with the organizations
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

getUserGroup

public Group getUserGroup(long companyId,
                          long userId)
                   throws PortalException,
                          SystemException
Returns the group associated with the user.

Specified by:
getUserGroup in interface GroupService
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

getUserGroupsGroups

public List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
                                throws PortalException,
                                       SystemException
Returns the groups associated with the user groups.

Specified by:
getUserGroupsGroups in interface GroupService
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

getUserOrganizationsGroups

public List<Group> getUserOrganizationsGroups(long userId,
                                              int start,
                                              int end)
                                       throws PortalException,
                                              SystemException
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.

Specified by:
getUserOrganizationsGroups in interface GroupService
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

getUserPlaces

public List<Group> getUserPlaces(long userId,
                                 String[] classNames,
                                 boolean includeControlPanel,
                                 int max)
                          throws PortalException,
                                 SystemException
Specified by:
getUserPlaces in interface GroupService
Throws:
PortalException
SystemException

getUserPlaces

public List<Group> getUserPlaces(long userId,
                                 String[] classNames,
                                 int max)
                          throws PortalException,
                                 SystemException
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.

Specified by:
getUserPlaces in interface GroupService
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

getUserPlaces

public List<Group> getUserPlaces(String[] classNames,
                                 int max)
                          throws PortalException,
                                 SystemException
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.

Specified by:
getUserPlaces in interface GroupService
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

getUserSites

public List<Group> getUserSites()
                         throws PortalException,
                                SystemException
Returns the guest or current user's layout set group, organization groups, inherited organization groups, and site groups.

Specified by:
getUserSites in interface GroupService
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

hasUserGroup

public boolean hasUserGroup(long userId,
                            long groupId)
                     throws PortalException,
                            SystemException
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.

Specified by:
hasUserGroup in interface GroupService
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

search

public List<Group> search(long companyId,
                          String name,
                          String description,
                          String[] params,
                          int start,
                          int end)
                   throws PortalException,
                          SystemException
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.

Specified by:
search in interface GroupService
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

searchCount

public int searchCount(long companyId,
                       String name,
                       String description,
                       String[] params)
                throws SystemException
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.

Specified by:
searchCount in interface GroupService
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

setRoleGroups

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

Specified by:
setRoleGroups in interface GroupService
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

unsetRoleGroups

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

Specified by:
unsetRoleGroups in interface GroupService
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

updateFriendlyURL

public Group updateFriendlyURL(long groupId,
                               String friendlyURL)
                        throws PortalException,
                               SystemException
Updates the group's friendly URL.

Specified by:
updateFriendlyURL in interface GroupService
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

updateGroup

public Group updateGroup(long groupId,
                         String typeSettings)
                  throws PortalException,
                         SystemException
Updates the group's type settings.

Specified by:
updateGroup in interface GroupService
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

updateGroup

public Group updateGroup(long groupId,
                         String name,
                         String description,
                         int type,
                         String friendlyURL,
                         boolean active,
                         ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Updates the group.

Specified by:
updateGroup in interface GroupService
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

getWrappedGroupService

public GroupService getWrappedGroupService()
Deprecated. Renamed to getWrappedService()


setWrappedGroupService

public void setWrappedGroupService(GroupService groupService)
Deprecated. Renamed to setWrappedService(com.liferay.portal.service.GroupService)


getWrappedService

public GroupService getWrappedService()
Specified by:
getWrappedService in interface ServiceWrapper<GroupService>

setWrappedService

public void setWrappedService(GroupService groupService)
Specified by:
setWrappedService in interface ServiceWrapper<GroupService>

Liferay 6.1.2-ce-ga3