|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.liferay.portal.service.base.PrincipalBean
com.liferay.portal.service.base.GroupServiceBaseImpl
com.liferay.portal.service.impl.GroupServiceImpl
public class GroupServiceImpl
The group remote service is responsible for accessing, creating, modifying
and deleting groups. For more information on group services and Group, see
GroupLocalServiceImpl.
| Field Summary |
|---|
| Fields inherited from class com.liferay.portal.service.base.PrincipalBean |
|---|
ANONYMOUS_NAMES, JRUN_ANONYMOUS, ORACLE_ANONYMOUS, SUN_ANONYMOUS, WEBLOGIC_ANONYMOUS |
| Constructor Summary | |
|---|---|
GroupServiceImpl()
|
|
| Method Summary | |
|---|---|
com.liferay.portal.model.Group |
addGroup(long liveGroupId,
java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean site,
boolean active,
com.liferay.portal.service.ServiceContext serviceContext)
Adds a group. |
com.liferay.portal.model.Group |
addGroup(java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean site,
boolean active,
com.liferay.portal.service.ServiceContext serviceContext)
Adds the group using the group default live group ID. |
void |
addRoleGroups(long roleId,
long[] groupIds)
Adds the groups to the role. |
void |
deleteGroup(long groupId)
Deletes the group. |
protected java.util.List<com.liferay.portal.model.Group> |
filterGroups(java.util.List<com.liferay.portal.model.Group> groups)
|
com.liferay.portal.model.Group |
getGroup(long groupId)
Returns the group with the primary key. |
com.liferay.portal.model.Group |
getGroup(long companyId,
java.lang.String name)
Returns the group with the name. |
java.util.List<com.liferay.portal.model.Group> |
getManageableSites(java.util.Collection<com.liferay.portal.model.Portlet> portlets,
int max)
Returns a range of all the site groups for which the user has control panel access. |
java.util.List<com.liferay.portal.model.Group> |
getOrganizationsGroups(java.util.List<com.liferay.portal.model.Organization> organizations)
Returns the groups associated with the organizations. |
com.liferay.portal.model.Group |
getUserGroup(long companyId,
long userId)
Returns the group associated with the user. |
java.util.List<com.liferay.portal.model.Group> |
getUserGroupsGroups(java.util.List<com.liferay.portal.model.UserGroup> userGroups)
Returns the groups associated with the user groups. |
java.util.List<com.liferay.portal.model.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<com.liferay.portal.model.Group> |
getUserPlaces(long userId,
java.lang.String[] classNames,
boolean includeControlPanel,
int max)
|
java.util.List<com.liferay.portal.model.Group> |
getUserPlaces(long userId,
java.lang.String[] classNames,
int max)
Returns the user's group "places" associated with the group entity class names, including the control panel group if the user is permitted to view the control panel. |
java.util.List<com.liferay.portal.model.Group> |
getUserPlaces(java.lang.String[] classNames,
int max)
Returns the guest or current user's group "places" associated with the group entity class names, including the control panel group if the user is permitted to view the control panel. |
java.util.List<com.liferay.portal.model.Group> |
getUserSites()
Returns the guest or current user's layout set group, organization groups, inherited organization groups, and site groups. |
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<com.liferay.portal.model.Group> |
search(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.String[] params,
int start,
int end)
Returns a name ordered range of all the site groups and organization groups that match the name and description, optionally including the user's inherited organization groups and user groups. |
int |
searchCount(long companyId,
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 |
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. |
com.liferay.portal.model.Group |
updateFriendlyURL(long groupId,
java.lang.String friendlyURL)
Updates the group's friendly URL. |
com.liferay.portal.model.Group |
updateGroup(long groupId,
java.lang.String typeSettings)
Updates the group's type settings. |
com.liferay.portal.model.Group |
updateGroup(long groupId,
java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean active,
com.liferay.portal.service.ServiceContext serviceContext)
Updates the group. |
| Methods inherited from class com.liferay.portal.service.base.PrincipalBean |
|---|
getGuestOrUser, getGuestOrUserId, getPermissionChecker, getUser, getUserId |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public GroupServiceImpl()
| Method Detail |
|---|
public com.liferay.portal.model.Group addGroup(long liveGroupId,
java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean site,
boolean active,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
liveGroupId - 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 GroupConstantsfriendlyURL - 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 staging
com.liferay.portal.kernel.exception.PortalException - if the user did not have permission to add the
group, if a creator could not be found, if the group's
information was invalid, if a layout could not be found, or if a
valid friendly URL could not be created for the group
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public com.liferay.portal.model.Group addGroup(java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean site,
boolean active,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
name - the entity's namedescription - the group's description (optionally
null)type - the group's type. For more information see GroupConstantsfriendlyURL - 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 staging
com.liferay.portal.kernel.exception.PortalException - if the user did not have permission to add the
group, if a creator could not be found, if the group's
information was invalid, if a layout could not be found, or if a
valid friendly URL could not be created for the group
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public void addRoleGroups(long roleId,
long[] groupIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
roleId - the primary key of the rolegroupIds - the primary keys of the groups
com.liferay.portal.kernel.exception.PortalException - if the user did not have permission to update the
role
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public void deleteGroup(long groupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
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 group
com.liferay.portal.kernel.exception.PortalException - if the user did not have permission to delete the
group or its assets or resources, if a group with the primary key
could not be found, or if the group was a system group
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public com.liferay.portal.model.Group getGroup(long groupId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
groupId - the primary key of the group
com.liferay.portal.kernel.exception.PortalException - if a group with the primary key could not be
found or if the current user did not have permission to view the
group
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public com.liferay.portal.model.Group getGroup(long companyId,
java.lang.String name)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
companyId - the primary key of the companyname - the group's name
com.liferay.portal.kernel.exception.PortalException - if a matching group could not be found or if the
current user did not have permission to view the group
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public java.util.List<com.liferay.portal.model.Group> getManageableSites(java.util.Collection<com.liferay.portal.model.Portlet> portlets,
int max)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
portlets - the portlets to managemax - the upper bound of the range of groups to consider (not
inclusive)
com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public java.util.List<com.liferay.portal.model.Group> getOrganizationsGroups(java.util.List<com.liferay.portal.model.Organization> organizations)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
organizations - the organizations
com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public com.liferay.portal.model.Group getUserGroup(long companyId,
long userId)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
companyId - the primary key of the companyuserId - the primary key of the user
com.liferay.portal.kernel.exception.PortalException - if a matching group could not be found or if the
current user did not have permission to view the group
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public java.util.List<com.liferay.portal.model.Group> getUserGroupsGroups(java.util.List<com.liferay.portal.model.UserGroup> userGroups)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
userGroups - the user groups
com.liferay.portal.kernel.exception.PortalException - if any one of the user group's group could not be
found
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public java.util.List<com.liferay.portal.model.Group> getUserOrganizationsGroups(long userId,
int start,
int end)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
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)
com.liferay.portal.kernel.exception.PortalException - if a user with the primary key could not be found
or if another portal exception occurred
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public java.util.List<com.liferay.portal.model.Group> getUserPlaces(long userId,
java.lang.String[] classNames,
boolean includeControlPanel,
int max)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException
public java.util.List<com.liferay.portal.model.Group> getUserPlaces(long userId,
java.lang.String[] classNames,
int max)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
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 getUserPlaces(long, String[], int)max - the maximum number of groups to return
com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public java.util.List<com.liferay.portal.model.Group> getUserPlaces(java.lang.String[] classNames,
int max)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
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 getUserPlaces(String[], int)max - the maximum number of groups to return
com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public java.util.List<com.liferay.portal.model.Group> getUserSites()
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public boolean hasUserGroup(long userId,
long groupId)
throws com.liferay.portal.kernel.exception.SystemException
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 group
true if the user is associated with the group;
false otherwise
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public java.util.List<com.liferay.portal.model.Group> search(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.String[] params,
int start,
int end)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
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 GroupFinderstart - the lower bound of the range of groups to returnend - the upper bound of the range of groups to return (not
inclusive)
com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public int searchCount(long companyId,
java.lang.String name,
java.lang.String description,
java.lang.String[] params)
throws com.liferay.portal.kernel.exception.SystemException
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
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public void setRoleGroups(long roleId,
long[] groupIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
roleId - the primary key of the rolegroupIds - the primary keys of the groups
com.liferay.portal.kernel.exception.PortalException - if the user did not have permission to update
update the role
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public void unsetRoleGroups(long roleId,
long[] groupIds)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
roleId - the primary key of the rolegroupIds - the primary keys of the groups
com.liferay.portal.kernel.exception.PortalException - if the user did not have permission to update the
role
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public com.liferay.portal.model.Group updateFriendlyURL(long groupId,
java.lang.String friendlyURL)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
groupId - the primary key of the groupfriendlyURL - the group's new friendlyURL (optionally
null)
com.liferay.portal.kernel.exception.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
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public com.liferay.portal.model.Group updateGroup(long groupId,
java.lang.String typeSettings)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
groupId - the primary key of the grouptypeSettings - the group's new type settings (optionally
null)
com.liferay.portal.kernel.exception.PortalException - if the user did not have permission to update the
group or if a group with the primary key could not be found
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
public com.liferay.portal.model.Group updateGroup(long groupId,
java.lang.String name,
java.lang.String description,
int type,
java.lang.String friendlyURL,
boolean active,
com.liferay.portal.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
groupId - the primary key of the groupname - the group's new namedescription - the group's new description (optionally
null)type - the group's new type. For more information see GroupConstantsfriendlyURL - 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.
com.liferay.portal.kernel.exception.PortalException - if the user did not have permission to update the
group, if a group with the primary key could not be found, if the
friendly URL was invalid or could one not be created
com.liferay.portal.kernel.exception.SystemException - if a system exception occurred
protected java.util.List<com.liferay.portal.model.Group> filterGroups(java.util.List<com.liferay.portal.model.Group> groups)
throws com.liferay.portal.kernel.exception.PortalException,
com.liferay.portal.kernel.exception.SystemException
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.SystemException
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||