Liferay 7.0-ce-b4

com.liferay.portal.service
Class GroupServiceWrapper

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

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

Provides a wrapper for GroupService.

See Also:
GroupService

Constructor Summary
GroupServiceWrapper(GroupService groupService)
           
 
Method Summary
 Group addGroup(long parentGroupId, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext)
           
 Group addGroup(long parentGroupId, long liveGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)
           
 Group addGroup(long parentGroupId, long liveGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean site, boolean active, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by addGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)
 void addRoleGroups(long roleId, long[] groupIds)
          Adds the groups to the role.
 void checkRemoteStagingGroup(long groupId)
          Checks that the current user is permitted to use the group for Remote Staging.
 void deleteGroup(long groupId)
          Deletes the group.
 void disableStaging(long groupId)
           
 void enableStaging(long groupId)
           
 Group getCompanyGroup(long companyId)
          Returns the company group.
 Group getGroup(long groupId)
          Returns the group with the primary key.
 Group getGroup(long companyId, String groupKey)
          Returns the group with the name.
 String getGroupDisplayURL(long groupId, boolean privateLayout, boolean secureConnection)
          Returns the group's display URL.
 List<Group> getGroups(long companyId, long parentGroupId, boolean site)
          Returns all the groups that are direct children of the parent group.
 List<Group> getManageableSiteGroups(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.
 String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
 Group getUserGroup(long companyId, long userId)
          Returns the group directly 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> getUserSitesGroups()
           
 List<Group> getUserSitesGroups(long userId, String[] classNames, int max)
          Returns the user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.
 List<Group> getUserSitesGroups(String[] classNames, int max)
          Returns the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.
 int getUserSitesGroupsCount()
          Returns the number of the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.
 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, long[] classNameIds, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator<Group> obc)
           
 List<Group> search(long companyId, long[] classNameIds, String name, String description, LinkedHashMap<String,Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc)
           
 List<Group> search(long companyId, String name, String description, String[] params, int start, int end)
          Returns an 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 setRoleGroups(long roleId, long[] groupIds)
          Sets the groups associated with the role, removing and adding associations as necessary.
 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, long parentGroupId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)
           
 Group updateGroup(long groupId, long parentGroupId, String name, String description, int type, boolean manualMembership, int membershipRestriction, String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext)
          Deprecated. As of 7.0.0, replaced by updateGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)
 Group updateGroup(long groupId, String typeSettings)
          Updates the group's type settings.
 void updateStagedPortlets(long groupId, Map<String,String> stagedPortletIds)
           
 
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

addGroup

@Deprecated
public Group addGroup(long parentGroupId,
                                 long liveGroupId,
                                 String name,
                                 String description,
                                 int type,
                                 boolean manualMembership,
                                 int membershipRestriction,
                                 String friendlyURL,
                                 boolean site,
                                 boolean active,
                                 ServiceContext serviceContext)
               throws PortalException
Deprecated. As of 7.0.0, replaced by addGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)

Adds a group.

Specified by:
addGroup in interface GroupService
Parameters:
parentGroupId - the primary key of the parent group
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.
manualMembership - whether manual membership is allowed for the group
membershipRestriction - the group's membership restriction. 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 a portal exception occurred

addGroup

public Group addGroup(long parentGroupId,
                      long liveGroupId,
                      Map<Locale,String> nameMap,
                      Map<Locale,String> descriptionMap,
                      int type,
                      boolean manualMembership,
                      int membershipRestriction,
                      String friendlyURL,
                      boolean site,
                      boolean active,
                      ServiceContext serviceContext)
               throws PortalException
Specified by:
addGroup in interface GroupService
Throws:
PortalException

addGroup

public Group addGroup(long parentGroupId,
                      long liveGroupId,
                      Map<Locale,String> nameMap,
                      Map<Locale,String> descriptionMap,
                      int type,
                      boolean manualMembership,
                      int membershipRestriction,
                      String friendlyURL,
                      boolean site,
                      boolean inheritContent,
                      boolean active,
                      ServiceContext serviceContext)
               throws PortalException
Specified by:
addGroup in interface GroupService
Throws:
PortalException

addRoleGroups

public void addRoleGroups(long roleId,
                          long[] groupIds)
                   throws PortalException
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 a portal exception occurred

checkRemoteStagingGroup

public void checkRemoteStagingGroup(long groupId)
                             throws PortalException
Checks that the current user is permitted to use the group for Remote Staging.

Specified by:
checkRemoteStagingGroup in interface GroupService
Parameters:
groupId - the primary key of the group
Throws:
PortalException - if a portal exception occurred

deleteGroup

public void deleteGroup(long groupId)
                 throws PortalException
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, and wikis are also deleted.

Specified by:
deleteGroup in interface GroupService
Parameters:
groupId - the primary key of the group
Throws:
PortalException - if a portal exception occurred

disableStaging

public void disableStaging(long groupId)
                    throws PortalException
Specified by:
disableStaging in interface GroupService
Throws:
PortalException

enableStaging

public void enableStaging(long groupId)
                   throws PortalException
Specified by:
enableStaging in interface GroupService
Throws:
PortalException

getCompanyGroup

public Group getCompanyGroup(long companyId)
                      throws PortalException
Returns the company group.

Specified by:
getCompanyGroup in interface GroupService
Parameters:
companyId - the primary key of the company
Returns:
the group associated with the company
Throws:
PortalException - if a portal exception occurred

getGroup

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

Specified by:
getGroup in interface GroupService
Parameters:
companyId - the primary key of the company
groupKey - the group key
Returns:
the group with the group key
Throws:
PortalException - if a portal exception occurred

getGroup

public Group getGroup(long groupId)
               throws PortalException
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 portal exception occurred

getGroupDisplayURL

public String getGroupDisplayURL(long groupId,
                                 boolean privateLayout,
                                 boolean secureConnection)
                          throws PortalException
Returns the group's display URL.

Specified by:
getGroupDisplayURL in interface GroupService
Parameters:
groupId - the primary key of the group
privateLayout - whether the layout set is private to the group
secureConnection - whether the generated URL uses a secure connection
Returns:
the group's display URL
Throws:
PortalException - if a group with the primary key could not be found or if a portal exception occurred

getGroups

public List<Group> getGroups(long companyId,
                             long parentGroupId,
                             boolean site)
                      throws PortalException
Returns all the groups that are direct children of the parent group.

Specified by:
getGroups in interface GroupService
Parameters:
companyId - the primary key of the company
parentGroupId - the primary key of the parent group
site - whether the group is to be associated with a main site
Returns:
the matching groups, or null if no matches were found
Throws:
PortalException - if a portal exception occurred

getManageableSiteGroups

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

Specified by:
getManageableSiteGroups 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

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Specified by:
getOSGiServiceIdentifier in interface GroupService
Returns:
the OSGi service identifier

getOrganizationsGroups

public List<Group> getOrganizationsGroups(List<Organization> organizations)
                                   throws PortalException
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

getUserGroup

public Group getUserGroup(long companyId,
                          long userId)
                   throws PortalException
Returns the group directly 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 directly associated with the user
Throws:
PortalException - if a portal exception occurred

getUserGroupsGroups

public List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
                                throws PortalException
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 a portal exception occurred

getUserOrganizationsGroups

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

getUserSitesGroups

public List<Group> getUserSitesGroups()
                               throws PortalException
Specified by:
getUserSitesGroups in interface GroupService
Throws:
PortalException

getUserSitesGroups

public List<Group> getUserSitesGroups(String[] classNames,
                                      int max)
                               throws PortalException
Returns the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.

Specified by:
getUserSitesGroups in interface GroupService
Parameters:
classNames - the group entity class names (optionally null). For more information see getUserSitesGroups(long, String[], int).
max - the maximum number of groups to return
Returns:
the user's groups "sites"
Throws:
PortalException - if a portal exception occurred

getUserSitesGroups

public List<Group> getUserSitesGroups(long userId,
                                      String[] classNames,
                                      int max)
                               throws PortalException
Returns the user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.

Specified by:
getUserSitesGroups in interface GroupService
Parameters:
userId - the primary key of the user
classNames - the group entity class names (optionally null). For more information see getUserSitesGroups(long, String[], int).
max - the maximum number of groups to return
Returns:
the user's groups "sites"
Throws:
PortalException - if a portal exception occurred

getUserSitesGroupsCount

public int getUserSitesGroupsCount()
                            throws PortalException
Returns the number of the guest or current user's groups "sites" associated with the group entity class names, including the Control Panel group if the user is permitted to view the Control Panel.

Specified by:
getUserSitesGroupsCount in interface GroupService
Returns:
the number of user's groups "sites"
Throws:
PortalException - if a portal exception occurred

hasUserGroup

public boolean hasUserGroup(long userId,
                            long groupId)
                     throws PortalException
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 a portal exception occurred

search

public List<Group> search(long companyId,
                          long[] classNameIds,
                          String keywords,
                          LinkedHashMap<String,Object> params,
                          int start,
                          int end,
                          OrderByComparator<Group> obc)
                   throws PortalException
Specified by:
search in interface GroupService
Throws:
PortalException

search

public List<Group> search(long companyId,
                          long[] classNameIds,
                          String name,
                          String description,
                          LinkedHashMap<String,Object> params,
                          boolean andOperator,
                          int start,
                          int end,
                          OrderByComparator<Group> obc)
                   throws PortalException
Specified by:
search in interface GroupService
Throws:
PortalException

search

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

searchCount

public 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. 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

setRoleGroups

public void setRoleGroups(long roleId,
                          long[] groupIds)
                   throws PortalException
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 a portal exception occurred

unsetRoleGroups

public void unsetRoleGroups(long roleId,
                            long[] groupIds)
                     throws PortalException
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 a portal exception occurred

updateFriendlyURL

public Group updateFriendlyURL(long groupId,
                               String friendlyURL)
                        throws PortalException
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 a portal exception occurred

updateGroup

@Deprecated
public Group updateGroup(long groupId,
                                    long parentGroupId,
                                    String name,
                                    String description,
                                    int type,
                                    boolean manualMembership,
                                    int membershipRestriction,
                                    String friendlyURL,
                                    boolean inheritContent,
                                    boolean active,
                                    ServiceContext serviceContext)
                  throws PortalException
Deprecated. As of 7.0.0, replaced by updateGroup(long, long, Map, Map, int, boolean, int, String, boolean, boolean, ServiceContext)

Updates the group.

Specified by:
updateGroup in interface GroupService
Parameters:
groupId - the primary key of the group
parentGroupId - the primary key of the parent group
name - the group's name
description - the group's new description (optionally null)
type - the group's new type. For more information see GroupConstants.
manualMembership - whether manual membership is allowed for the group
membershipRestriction - the group's membership restriction. For more information see GroupConstants.
friendlyURL - the group's new friendlyURL (optionally null)
inheritContent - whether to inherit content from the parent group
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 a portal exception occurred

updateGroup

public Group updateGroup(long groupId,
                         long parentGroupId,
                         Map<Locale,String> nameMap,
                         Map<Locale,String> descriptionMap,
                         int type,
                         boolean manualMembership,
                         int membershipRestriction,
                         String friendlyURL,
                         boolean inheritContent,
                         boolean active,
                         ServiceContext serviceContext)
                  throws PortalException
Specified by:
updateGroup in interface GroupService
Throws:
PortalException

updateGroup

public Group updateGroup(long groupId,
                         String typeSettings)
                  throws PortalException
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 a portal exception occurred

updateStagedPortlets

public void updateStagedPortlets(long groupId,
                                 Map<String,String> stagedPortletIds)
                          throws PortalException
Specified by:
updateStagedPortlets in interface GroupService
Throws:
PortalException

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 7.0-ce-b4