@ProviderType public class GroupServiceWrapper extends java.lang.Object implements GroupService, ServiceWrapper<GroupService>
GroupService.GroupService| Constructor and Description |
|---|
GroupServiceWrapper(GroupService groupService) |
| Modifier and Type | Method and Description |
|---|---|
Group |
addGroup(long parentGroupId,
long liveGroupId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
int type,
boolean manualMembership,
int membershipRestriction,
java.lang.String friendlyURL,
boolean site,
boolean inheritContent,
boolean active,
ServiceContext serviceContext) |
Group |
addGroup(long parentGroupId,
long liveGroupId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
int type,
boolean manualMembership,
int membershipRestriction,
java.lang.String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext) |
Group |
addGroup(long parentGroupId,
long liveGroupId,
java.lang.String name,
java.lang.String description,
int type,
boolean manualMembership,
int membershipRestriction,
java.lang.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) |
Group |
addGroup(long parentGroupId,
java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Deprecated.
As of 6.2.0, replaced by
addGroup(long, long, Map,
Map, int, boolean, int, String, boolean, boolean,
ServiceContext) |
Group |
addGroup(java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean site,
boolean active,
ServiceContext serviceContext)
Deprecated.
As of 6.2.0, replaced by
addGroup(long, String,
String, 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) |
java.lang.String |
getBeanIdentifier()
Returns the Spring bean ID for this bean.
|
Group |
getCompanyGroup(long companyId)
Returns the company group.
|
Group |
getGroup(long groupId)
Returns the group with the primary key.
|
Group |
getGroup(long companyId,
java.lang.String groupKey)
Returns the group with the name.
|
java.util.List<Group> |
getGroups(long companyId,
long parentGroupId,
boolean site)
Returns all the groups that are direct children of the parent group.
|
java.util.List<Group> |
getManageableSiteGroups(java.util.Collection<Portlet> portlets,
int max)
Returns a range of all the site groups for which the user has control
panel access.
|
java.util.List<Group> |
getManageableSites(java.util.Collection<Portlet> portlets,
int max)
Deprecated.
As of 6.2.0, replaced by
getManageableSiteGroups(Collection, int) |
java.util.List<Group> |
getOrganizationsGroups(java.util.List<Organization> organizations)
Returns the groups associated with the organizations.
|
Group |
getUserGroup(long companyId,
long userId)
Returns the group directly associated with the user.
|
java.util.List<Group> |
getUserGroupsGroups(java.util.List<UserGroup> userGroups)
Returns the groups associated with the user groups.
|
java.util.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. |
java.util.List<Group> |
getUserPlaces(long userId,
java.lang.String[] classNames,
boolean includeControlPanel,
int max)
Deprecated.
As of 6.2.0, replaced by
getUserSitesGroups(long,
String[], boolean, int) |
java.util.List<Group> |
getUserPlaces(long userId,
java.lang.String[] classNames,
int max)
Deprecated.
As of 6.2.0, replaced by
getUserSitesGroups(long,
String[], int) |
java.util.List<Group> |
getUserPlaces(java.lang.String[] classNames,
int max)
Deprecated.
As of 6.2.0, replaced by
getUserSitesGroups(String[],
int) |
int |
getUserPlacesCount()
Deprecated.
As of 6.2.0, replaced by
getUserSitesGroupsCount() |
java.util.List<Group> |
getUserSites()
Deprecated.
As of 6.2.0, replaced by
getUserSitesGroups() |
java.util.List<Group> |
getUserSitesGroups() |
java.util.List<Group> |
getUserSitesGroups(long userId,
java.lang.String[] classNames,
boolean includeControlPanel,
int max) |
java.util.List<Group> |
getUserSitesGroups(long userId,
java.lang.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.
|
java.util.List<Group> |
getUserSitesGroups(java.lang.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 |
getWrappedGroupService()
Deprecated.
As of 6.1.0, replaced by
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. |
java.util.List<Group> |
search(long companyId,
long[] classNameIds,
java.lang.String keywords,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
int start,
int end,
OrderByComparator<Group> obc) |
java.util.List<Group> |
search(long companyId,
long[] classNameIds,
java.lang.String name,
java.lang.String description,
java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
boolean andOperator,
int start,
int end,
OrderByComparator<Group> obc) |
java.util.List<Group> |
search(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.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,
java.lang.String name,
java.lang.String description,
java.lang.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(java.lang.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.
As of 6.1.0, replaced by
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,
java.lang.String friendlyURL)
Updates the group's friendly URL.
|
Group |
updateGroup(long groupId,
long parentGroupId,
java.util.Map<java.util.Locale,java.lang.String> nameMap,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
int type,
boolean manualMembership,
int membershipRestriction,
java.lang.String friendlyURL,
boolean inheritContent,
boolean active,
ServiceContext serviceContext) |
Group |
updateGroup(long groupId,
long parentGroupId,
java.lang.String name,
java.lang.String description,
int type,
boolean manualMembership,
int membershipRestriction,
java.lang.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,
java.lang.String typeSettings)
Updates the group's type settings.
|
void |
updateStagedPortlets(long groupId,
java.util.Map<java.lang.String,java.lang.String> stagedPortletIds) |
public GroupServiceWrapper(GroupService groupService)
@Deprecated public Group addGroup(java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException
addGroup(long, String,
String, int, String, boolean, boolean, ServiceContext)addGroup in interface GroupServicePortalException@Deprecated public Group addGroup(long parentGroupId, long liveGroupId, java.lang.String name, java.lang.String description, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException
addGroup(long, long, Map,
Map, int, boolean, int, String, boolean, boolean,
ServiceContext)addGroup in interface GroupServiceparentGroupId - the primary key of the parent groupliveGroupId - the primary key of the live groupname - the entity's namedescription - the group's description (optionally
null)type - the group's type. For more information see GroupConstants.manualMembership - whether manual membership is allowed for the
groupmembershipRestriction - 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 siteactive - whether the group is activeserviceContext - 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
stagingPortalException - 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 grouppublic Group addGroup(long parentGroupId, long liveGroupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException
addGroup in interface GroupServicePortalExceptionpublic Group addGroup(long parentGroupId, long liveGroupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean site, boolean inheritContent, boolean active, ServiceContext serviceContext) throws PortalException
addGroup in interface GroupServicePortalException@Deprecated public Group addGroup(long parentGroupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean site, boolean active, ServiceContext serviceContext) throws PortalException
addGroup(long, long, Map,
Map, int, boolean, int, String, boolean, boolean,
ServiceContext)addGroup in interface GroupServiceparentGroupId - the primary key of the parent groupname - the entity's namedescription - the group's description (optionally
null)type - the group's type. For more information see GroupConstants.friendlyURL - the group's friendlyURLsite - whether the group is to be associated with a main siteactive - whether the group is activeserviceContext - 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
stagingPortalException - 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 grouppublic void addRoleGroups(long roleId,
long[] groupIds)
throws PortalException
addRoleGroups in interface GroupServiceroleId - the primary key of the rolegroupIds - the primary keys of the groupsPortalException - if the user did not have permission to update the
rolepublic void checkRemoteStagingGroup(long groupId)
throws PortalException
checkRemoteStagingGroup in interface GroupServicegroupId - the primary key of the groupPortalException - if a group with the primary key could not be
found, if the current user did not have permission to view the
group, or if the group's company was different from the current
user's companypublic void deleteGroup(long groupId)
throws PortalException
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.
deleteGroup in interface GroupServicegroupId - the primary key of the groupPortalException - 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 grouppublic void disableStaging(long groupId)
throws PortalException
disableStaging in interface GroupServicePortalExceptionpublic void enableStaging(long groupId)
throws PortalException
enableStaging in interface GroupServicePortalExceptionpublic java.lang.String getBeanIdentifier()
getBeanIdentifier in interface GroupServicepublic Group getCompanyGroup(long companyId) throws PortalException
getCompanyGroup in interface GroupServicecompanyId - the primary key of the companyPortalException - if a matching group could not be foundpublic Group getGroup(long companyId, java.lang.String groupKey) throws PortalException
getGroup in interface GroupServicecompanyId - the primary key of the companygroupKey - the group keyPortalException - if a matching group could not be found or if the
current user did not have permission to view the grouppublic Group getGroup(long groupId) throws PortalException
getGroup in interface GroupServicegroupId - the primary key of the groupPortalException - if a group with the primary key could not be
found or if the current user did not have permission to view the
grouppublic java.util.List<Group> getGroups(long companyId, long parentGroupId, boolean site) throws PortalException
getGroups in interface GroupServicecompanyId - the primary key of the companyparentGroupId - the primary key of the parent groupsite - whether the group is to be associated with a main sitenull if no matches were
foundPortalException - if the user did not have permission to view the
group or if a portal exception occurredpublic java.util.List<Group> getManageableSiteGroups(java.util.Collection<Portlet> portlets, int max) throws PortalException
getManageableSiteGroups in interface GroupServiceportlets - the portlets to managemax - the upper bound of the range of groups to consider (not
inclusive)PortalException - if a portal exception occurred@Deprecated public java.util.List<Group> getManageableSites(java.util.Collection<Portlet> portlets, int max) throws PortalException
getManageableSiteGroups(Collection, int)getManageableSites in interface GroupServiceportlets - the portlets to managemax - the upper bound of the range of groups to consider (not
inclusive)PortalException - if a portal exception occurredpublic java.util.List<Group> getOrganizationsGroups(java.util.List<Organization> organizations) throws PortalException
getOrganizationsGroups in interface GroupServiceorganizations - the organizationsPortalException - if a portal exception occurredpublic Group getUserGroup(long companyId, long userId) throws PortalException
getUserGroup in interface GroupServicecompanyId - the primary key of the companyuserId - the primary key of the userPortalException - if a matching group could not be found or if the
current user did not have permission to view the grouppublic java.util.List<Group> getUserGroupsGroups(java.util.List<UserGroup> userGroups) throws PortalException
getUserGroupsGroups in interface GroupServiceuserGroups - the user groupsPortalException - if any one of the user group's group could not be
foundpublic java.util.List<Group> getUserOrganizationsGroups(long userId, int start, int end) throws PortalException
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.
getUserOrganizationsGroups in interface GroupServiceuserId - the primary key of the userstart - the lower bound of the range of groups to considerend - the upper bound of the range of groups to consider (not
inclusive)PortalException - if a user with the primary key could not be found
or if another portal exception occurred@Deprecated public java.util.List<Group> getUserPlaces(java.lang.String[] classNames, int max) throws PortalException
getUserSitesGroups(String[],
int)classNames
value of null includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
getUserPlaces in interface GroupServiceclassNames - the group entity class names (optionally
null). For more information see getUserSitesGroups(String[], int).max - the maximum number of groups to returnPortalException - if a portal exception occurred@Deprecated public java.util.List<Group> getUserPlaces(long userId, java.lang.String[] classNames, boolean includeControlPanel, int max) throws PortalException
getUserSitesGroups(long,
String[], boolean, int)getUserPlaces in interface GroupServicePortalException@Deprecated public java.util.List<Group> getUserPlaces(long userId, java.lang.String[] classNames, int max) throws PortalException
getUserSitesGroups(long,
String[], int)classNames
value of null includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
getUserPlaces in interface GroupServiceuserId - the primary key of the userclassNames - the group entity class names (optionally
null). For more information see getUserSitesGroups(long, String[], int).max - the maximum number of groups to returnPortalException - if a portal exception occurred@Deprecated
public int getUserPlacesCount()
throws PortalException
getUserSitesGroupsCount()getUserPlacesCount in interface GroupServicePortalException - if a portal exception occurred@Deprecated public java.util.List<Group> getUserSites() throws PortalException
getUserSitesGroups()getUserSites in interface GroupServicePortalException - if a portal exception occurredpublic java.util.List<Group> getUserSitesGroups() throws PortalException
getUserSitesGroups in interface GroupServicePortalExceptionpublic java.util.List<Group> getUserSitesGroups(java.lang.String[] classNames, int max) throws PortalException
classNames
value of null includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
getUserSitesGroups in interface GroupServiceclassNames - the group entity class names (optionally
null). For more information see getUserSitesGroups(long, String[], boolean, int).max - the maximum number of groups to returnPortalException - if a portal exception occurredpublic java.util.List<Group> getUserSitesGroups(long userId, java.lang.String[] classNames, boolean includeControlPanel, int max) throws PortalException
getUserSitesGroups in interface GroupServicePortalExceptionpublic java.util.List<Group> getUserSitesGroups(long userId, java.lang.String[] classNames, int max) throws PortalException
classNames
value of null includes the user's layout set group,
organization groups, inherited organization groups, and site groups.
getUserSitesGroups in interface GroupServiceuserId - the primary key of the userclassNames - the group entity class names (optionally
null). For more information see getUserSitesGroups(long, String[], boolean, int).max - the maximum number of groups to returnPortalException - if a portal exception occurredpublic int getUserSitesGroupsCount()
throws PortalException
getUserSitesGroupsCount in interface GroupServicePortalException - if a portal exception occurredpublic boolean hasUserGroup(long userId,
long groupId)
throws PortalException
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.hasUserGroup in interface GroupServiceuserId - the primary key of the usergroupId - the primary key of the grouptrue if the user is associated with the group;
false otherwisePortalException - if the current user did not have permission to
view the user or group memberspublic java.util.List<Group> search(long companyId, long[] classNameIds, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator<Group> obc) throws PortalException
search in interface GroupServicePortalExceptionpublic java.util.List<Group> search(long companyId, long[] classNameIds, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, boolean andOperator, int start, int end, OrderByComparator<Group> obc) throws PortalException
search in interface GroupServicePortalExceptionpublic java.util.List<Group> search(long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params, int start, int end) throws PortalException
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.
search in interface GroupServicecompanyId - the primary key of the companyname - 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 returnend - the upper bound of the range of groups to return (not
inclusive)PortalException - if a portal exception occurredpublic int searchCount(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.String[] params)
searchCount in interface GroupServicecompanyId - the primary key of the companyname - 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.public void setBeanIdentifier(java.lang.String beanIdentifier)
setBeanIdentifier in interface GroupServicebeanIdentifier - the Spring bean ID for this beanpublic void setRoleGroups(long roleId,
long[] groupIds)
throws PortalException
setRoleGroups in interface GroupServiceroleId - the primary key of the rolegroupIds - the primary keys of the groupsPortalException - if the user did not have permission to update
update the rolepublic void unsetRoleGroups(long roleId,
long[] groupIds)
throws PortalException
unsetRoleGroups in interface GroupServiceroleId - the primary key of the rolegroupIds - the primary keys of the groupsPortalException - if the user did not have permission to update the
rolepublic Group updateFriendlyURL(long groupId, java.lang.String friendlyURL) throws PortalException
updateFriendlyURL in interface GroupServicegroupId - the primary key of the groupfriendlyURL - the group's new friendlyURL (optionally
null)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@Deprecated public Group updateGroup(long groupId, long parentGroupId, java.lang.String name, java.lang.String description, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext) throws PortalException
updateGroup(long, long, Map,
Map, int, boolean, int, String, boolean, boolean,
ServiceContext)updateGroup in interface GroupServicegroupId - the primary key of the groupparentGroupId - the primary key of the parent groupname - the group's namedescription - 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
groupmembershipRestriction - the group's membership restriction. For
more information see GroupConstants.friendlyURL - the group's new friendlyURL (optionally
null)active - whether the group is activeserviceContext - the service context to be applied (optionally
null). Can set the asset category IDs and asset
tag names for the group.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
createdpublic Group updateGroup(long groupId, long parentGroupId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int type, boolean manualMembership, int membershipRestriction, java.lang.String friendlyURL, boolean inheritContent, boolean active, ServiceContext serviceContext) throws PortalException
updateGroup in interface GroupServicePortalExceptionpublic Group updateGroup(long groupId, java.lang.String typeSettings) throws PortalException
updateGroup in interface GroupServicegroupId - the primary key of the grouptypeSettings - the group's new type settings (optionally
null)PortalException - if the user did not have permission to update the
group or if a group with the primary key could not be foundpublic void updateStagedPortlets(long groupId,
java.util.Map<java.lang.String,java.lang.String> stagedPortletIds)
throws PortalException
updateStagedPortlets in interface GroupServicePortalException@Deprecated public GroupService getWrappedGroupService()
getWrappedService()@Deprecated public void setWrappedGroupService(GroupService groupService)
setWrappedService(com.liferay.portal.service.GroupService)public GroupService getWrappedService()
getWrappedService in interface ServiceWrapper<GroupService>public void setWrappedService(GroupService groupService)
setWrappedService in interface ServiceWrapper<GroupService>