@AccessControlled @JSONWebService @ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface GroupService extends BaseService
GroupServiceUtil,
GroupServiceBaseImpl,
com.liferay.portal.service.impl.GroupServiceImpl| 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[], 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,
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.
|
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 |
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) |
@Deprecated 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 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
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 groupGroup 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
PortalExceptionGroup 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 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
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 groupvoid addRoleGroups(long roleId,
long[] groupIds)
throws PortalException
roleId - the primary key of the rolegroupIds - the primary keys of the groupsPortalException - if the user did not have permission to update the
rolevoid checkRemoteStagingGroup(long groupId)
throws PortalException
groupId - 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 companyvoid 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.
groupId - 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 groupvoid disableStaging(long groupId)
throws PortalException
PortalExceptionvoid enableStaging(long groupId)
throws PortalException
PortalExceptionjava.lang.String getBeanIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) Group getCompanyGroup(long companyId) throws PortalException
companyId - the primary key of the companyPortalException - if a matching group could not be found@Transactional(propagation=SUPPORTS, readOnly=true) Group getGroup(long companyId, java.lang.String groupKey) throws PortalException
companyId - 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 group@Transactional(propagation=SUPPORTS, readOnly=true) Group getGroup(long groupId) throws PortalException
groupId - 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
group@Transactional(propagation=SUPPORTS, readOnly=true) 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
foundPortalException - if the user did not have permission to view the
group or if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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 - if a portal exception occurred@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) 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)PortalException - if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Group> getOrganizationsGroups(java.util.List<Organization> organizations) throws PortalException
organizations - the organizationsPortalException - if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) Group getUserGroup(long companyId, long userId) throws PortalException
companyId - 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 group@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Group> getUserGroupsGroups(java.util.List<UserGroup> userGroups) throws PortalException
userGroups - the user groupsPortalException - if any one of the user group's group could not be
found@Transactional(propagation=SUPPORTS, readOnly=true) 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 - if a user with the primary key could not be found
or if another portal exception occurred@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) 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 - if a portal exception occurred@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Group> getUserPlaces(long userId, java.lang.String[] classNames, boolean includeControlPanel, int max) throws PortalException
getUserSitesGroups(long,
String[], int)PortalException@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) 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 - if a portal exception occurred@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) int getUserPlacesCount() throws PortalException
getUserSitesGroupsCount()PortalException - if a portal exception occurred@Deprecated @Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Group> getUserSites() throws PortalException
getUserSitesGroups()PortalException - if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<Group> getUserSitesGroups() throws PortalException
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) 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 returnPortalException - if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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 returnPortalException - if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) int getUserSitesGroupsCount() throws PortalException
PortalException - if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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 otherwisePortalException - if the current user did not have permission to
view the user or group members@Transactional(propagation=SUPPORTS, readOnly=true) 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
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) 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
PortalException@Transactional(propagation=SUPPORTS, readOnly=true) 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)PortalException - if a portal exception occurred@Transactional(propagation=SUPPORTS, readOnly=true) 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.void setBeanIdentifier(java.lang.String beanIdentifier)
beanIdentifier - the Spring bean ID for this beanvoid setRoleGroups(long roleId,
long[] groupIds)
throws PortalException
roleId - the primary key of the rolegroupIds - the primary keys of the groupsPortalException - if the user did not have permission to update
update the rolevoid unsetRoleGroups(long roleId,
long[] groupIds)
throws PortalException
roleId - the primary key of the rolegroupIds - the primary keys of the groupsPortalException - if the user did not have permission to update the
roleGroup updateFriendlyURL(long groupId, java.lang.String friendlyURL) throws PortalException
groupId - 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 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.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
createdGroup 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
PortalExceptionGroup updateGroup(long groupId, java.lang.String typeSettings) throws PortalException
groupId - 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 foundvoid updateStagedPortlets(long groupId,
java.util.Map<java.lang.String,java.lang.String> stagedPortletIds)
throws PortalException
PortalException