@ProviderType
public class GroupServiceUtil
extends java.lang.Object
com.liferay.portal.service.impl.GroupServiceImpl and is the
primary access point for service operations in application layer code running
on a remote server. Methods of this service are expected to have security
checks based on the propagated JAAS credentials because this service can be
accessed remotely.GroupService,
GroupServiceBaseImpl,
com.liferay.portal.service.impl.GroupServiceImpl| Constructor and Description |
|---|
GroupServiceUtil() |
| Modifier and Type | Method and Description |
|---|---|
static 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) |
static 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) |
static 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) |
static 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) |
static 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) |
static void |
addRoleGroups(long roleId,
long[] groupIds)
Adds the groups to the role.
|
static void |
checkRemoteStagingGroup(long groupId)
Checks that the current user is permitted to use the group for Remote
Staging.
|
static void |
deleteGroup(long groupId)
Deletes the group.
|
static void |
disableStaging(long groupId) |
static void |
enableStaging(long groupId) |
static Group |
getCompanyGroup(long companyId)
Returns the company group.
|
static Group |
getGroup(long groupId)
Returns the group with the primary key.
|
static Group |
getGroup(long companyId,
java.lang.String groupKey)
Returns the group with the name.
|
static java.lang.String |
getGroupDisplayURL(long groupId,
boolean privateLayout,
boolean secureConnection) |
static java.util.List<Group> |
getGroups(long companyId,
long parentGroupId,
boolean site)
Returns all the groups that are direct children of the parent group.
|
static 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.
|
static java.util.List<Group> |
getManageableSites(java.util.Collection<Portlet> portlets,
int max)
Deprecated.
As of 6.2.0, replaced by
getManageableSiteGroups(Collection, int) |
static java.util.List<Group> |
getOrganizationsGroups(java.util.List<Organization> organizations)
Returns the groups associated with the organizations.
|
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static GroupService |
getService() |
static Group |
getUserGroup(long companyId,
long userId)
Returns the group directly associated with the user.
|
static java.util.List<Group> |
getUserGroupsGroups(java.util.List<UserGroup> userGroups)
Returns the groups associated with the user groups.
|
static 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. |
static 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[], int) |
static 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) |
static java.util.List<Group> |
getUserPlaces(java.lang.String[] classNames,
int max)
Deprecated.
As of 6.2.0, replaced by
getUserSitesGroups(String[],
int) |
static int |
getUserPlacesCount()
Deprecated.
As of 6.2.0, replaced by
getUserSitesGroupsCount() |
static java.util.List<Group> |
getUserSites()
Deprecated.
As of 6.2.0, replaced by
getUserSitesGroups() |
static java.util.List<Group> |
getUserSitesGroups() |
static 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.
|
static 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.
|
static 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.
|
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 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) |
static 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) |
static 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.
|
static 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.
|
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 Group |
updateFriendlyURL(long groupId,
java.lang.String friendlyURL)
Updates the group's friendly URL.
|
static 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) |
static 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) |
static Group |
updateGroup(long groupId,
java.lang.String typeSettings)
Updates the group's type settings.
|
static void |
updateStagedPortlets(long groupId,
java.util.Map<java.lang.String,java.lang.String> stagedPortletIds) |
@Deprecated public static 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)PortalException@Deprecated public static 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)parentGroupId - 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
stagingPortalExceptionpublic static 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
PortalExceptionpublic static 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
PortalException@Deprecated public static 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)parentGroupId - 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
stagingPortalExceptionpublic static void addRoleGroups(long roleId,
long[] groupIds)
throws PortalException
roleId - the primary key of the rolegroupIds - the primary keys of the groupsPortalExceptionpublic static void checkRemoteStagingGroup(long groupId)
throws PortalException
groupId - the primary key of the groupPortalExceptionpublic static 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, and wikis are also deleted.
groupId - the primary key of the groupPortalExceptionpublic static void disableStaging(long groupId)
throws PortalException
PortalExceptionpublic static void enableStaging(long groupId)
throws PortalException
PortalExceptionpublic static Group getCompanyGroup(long companyId) throws PortalException
companyId - the primary key of the companyPortalExceptionpublic static Group getGroup(long companyId, java.lang.String groupKey) throws PortalException
companyId - the primary key of the companygroupKey - the group keyPortalExceptionpublic static Group getGroup(long groupId) throws PortalException
groupId - the primary key of the groupPortalExceptionpublic static java.lang.String getGroupDisplayURL(long groupId,
boolean privateLayout,
boolean secureConnection)
throws PortalException
PortalExceptionpublic static java.util.List<Group> getGroups(long companyId, long parentGroupId, boolean site) throws PortalException
companyId - 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
foundPortalExceptionpublic static java.util.List<Group> getManageableSiteGroups(java.util.Collection<Portlet> portlets, int max) throws PortalException
portlets - the portlets to managemax - the upper bound of the range of groups to consider (not
inclusive)PortalException@Deprecated public static java.util.List<Group> getManageableSites(java.util.Collection<Portlet> portlets, int max) throws PortalException
getManageableSiteGroups(Collection, int)portlets - the portlets to managemax - the upper bound of the range of groups to consider (not
inclusive)PortalExceptionpublic static java.lang.String getOSGiServiceIdentifier()
public static java.util.List<Group> getOrganizationsGroups(java.util.List<Organization> organizations) throws PortalException
organizations - the organizationsPortalExceptionpublic static Group getUserGroup(long companyId, long userId) throws PortalException
companyId - the primary key of the companyuserId - the primary key of the userPortalExceptionpublic static java.util.List<Group> getUserGroupsGroups(java.util.List<UserGroup> userGroups) throws PortalException
userGroups - the user groupsPortalExceptionpublic static 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.
userId - 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@Deprecated public static 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.
classNames - the group entity class names (optionally
null). For more information see getUserSitesGroups(String[], int).max - the maximum number of groups to returnPortalException@Deprecated public static java.util.List<Group> getUserPlaces(long userId, java.lang.String[] classNames, boolean includeControlPanel, int max) throws PortalException
getUserSitesGroups(long,
String[], int)PortalException@Deprecated public static 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.
userId - 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@Deprecated
public static int getUserPlacesCount()
throws PortalException
getUserSitesGroupsCount()PortalException@Deprecated public static java.util.List<Group> getUserSites() throws PortalException
getUserSitesGroups()PortalExceptionpublic static java.util.List<Group> getUserSitesGroups() throws PortalException
PortalExceptionpublic static 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.
classNames - the group entity class names (optionally
null). For more information see getUserSitesGroups(long, String[], int).max - the maximum number of groups to returnPortalExceptionpublic static 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.
userId - 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 returnPortalExceptionpublic static int getUserSitesGroupsCount()
throws PortalException
PortalExceptionpublic static 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.userId - the primary key of the usergroupId - the primary key of the grouptrue if the user is associated with the group;
false otherwisePortalExceptionpublic static 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
PortalExceptionpublic static 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
PortalExceptionpublic static 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.
companyId - 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)PortalExceptionpublic static int searchCount(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.String[] params)
companyId - 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 static void setRoleGroups(long roleId,
long[] groupIds)
throws PortalException
roleId - the primary key of the rolegroupIds - the primary keys of the groupsPortalExceptionpublic static void unsetRoleGroups(long roleId,
long[] groupIds)
throws PortalException
roleId - the primary key of the rolegroupIds - the primary keys of the groupsPortalExceptionpublic static Group updateFriendlyURL(long groupId, java.lang.String friendlyURL) throws PortalException
groupId - the primary key of the groupfriendlyURL - the group's new friendlyURL (optionally
null)PortalException@Deprecated public static 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)groupId - 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.PortalExceptionpublic static 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
PortalExceptionpublic static Group updateGroup(long groupId, java.lang.String typeSettings) throws PortalException
groupId - the primary key of the grouptypeSettings - the group's new type settings (optionally
null)PortalExceptionpublic static void updateStagedPortlets(long groupId,
java.util.Map<java.lang.String,java.lang.String> stagedPortletIds)
throws PortalException
PortalExceptionpublic static GroupService getService()