|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.UserGroupServiceUtil
@ProviderType public class UserGroupServiceUtil
Provides the remote service utility for UserGroup. This utility wraps
com.liferay.portal.service.impl.UserGroupServiceImpl
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.
UserGroupService
,
UserGroupServiceBaseImpl
,
com.liferay.portal.service.impl.UserGroupServiceImpl
Constructor Summary | |
---|---|
UserGroupServiceUtil()
|
Method Summary | |
---|---|
static void |
addGroupUserGroups(long groupId,
long[] userGroupIds)
Adds the user groups to the group. |
static void |
addTeamUserGroups(long teamId,
long[] userGroupIds)
Adds the user groups to the team |
static UserGroup |
addUserGroup(String name,
String description)
Deprecated. As of 6.2.0, replaced by addUserGroup(String, String,
ServiceContext) |
static UserGroup |
addUserGroup(String name,
String description,
ServiceContext serviceContext)
Adds a user group. |
static void |
deleteUserGroup(long userGroupId)
Deletes the user group. |
static String |
getBeanIdentifier()
Returns the Spring bean ID for this bean. |
static UserGroupService |
getService()
|
static UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key. |
static UserGroup |
getUserGroup(String name)
Returns the user group with the name. |
static List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs. |
static void |
setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean. |
void |
setService(UserGroupService service)
Deprecated. As of 6.2.0 |
static void |
unsetGroupUserGroups(long groupId,
long[] userGroupIds)
Removes the user groups from the group. |
static void |
unsetTeamUserGroups(long teamId,
long[] userGroupIds)
Removes the user groups from the team. |
static UserGroup |
updateUserGroup(long userGroupId,
String name,
String description)
Deprecated. As of 6.2.0, replaced by updateUserGroup(long,
String, String, ServiceContext) |
static UserGroup |
updateUserGroup(long userGroupId,
String name,
String description,
ServiceContext serviceContext)
Updates the user group. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public UserGroupServiceUtil()
Method Detail |
---|
public static String getBeanIdentifier()
public static void setBeanIdentifier(String beanIdentifier)
beanIdentifier
- the Spring bean ID for this beanpublic static void addGroupUserGroups(long groupId, long[] userGroupIds) throws PortalException, SystemException
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups
PortalException
- if a group or user group with the primary key
could not be found, or if the user did not have permission to
assign group members
SystemException
- if a system exception occurredpublic static void addTeamUserGroups(long teamId, long[] userGroupIds) throws PortalException, SystemException
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups
PortalException
- if a team or user group with the primary key
could not be found, or if the user did not have permission to
assign team members
SystemException
- if a system exception occurredpublic static UserGroup addUserGroup(String name, String description) throws PortalException, SystemException
addUserGroup(String, String,
ServiceContext)
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.
name
- the user group's namedescription
- the user group's description
PortalException
- if the user group's information was invalid
or if the user did not have permission to add the user group
SystemException
- if a system exception occurredpublic static UserGroup addUserGroup(String name, String description, ServiceContext serviceContext) throws PortalException, SystemException
This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures.
name
- the user group's namedescription
- the user group's descriptionserviceContext
- the service context to be applied (optionally
null
). Can set expando bridge attributes for the
user group.
PortalException
- if the user group's information was invalid or if
the user did not have permission to add the user group
SystemException
- if a system exception occurredpublic static void deleteUserGroup(long userGroupId) throws PortalException, SystemException
userGroupId
- the primary key of the user group
PortalException
- if a user group with the primary key could not be
found, if the user did not have permission to delete the user
group, or if the user group had a workflow in approved status
SystemException
- if a system exception occurredpublic static UserGroup getUserGroup(long userGroupId) throws PortalException, SystemException
userGroupId
- the primary key of the user group
PortalException
- if a user group with the primary key could not be
found or if the user did not have permission to view the user
group
SystemException
- if a system exception occurredpublic static UserGroup getUserGroup(String name) throws PortalException, SystemException
name
- the user group's name
PortalException
- if a user group with the name could not be found
or if the user did not have permission to view the user group
SystemException
- if a system exception occurredpublic static List<UserGroup> getUserUserGroups(long userId) throws PortalException, SystemException
userId
- the primary key of the user
PortalException
- if the current user did not have permission to
view the user or any one of the user group members
SystemException
- if a system exception occurredpublic static void unsetGroupUserGroups(long groupId, long[] userGroupIds) throws PortalException, SystemException
groupId
- the primary key of the groupuserGroupIds
- the primary keys of the user groups
PortalException
- if the user did not have permission to assign
group members
SystemException
- if a system exception occurredpublic static void unsetTeamUserGroups(long teamId, long[] userGroupIds) throws PortalException, SystemException
teamId
- the primary key of the teamuserGroupIds
- the primary keys of the user groups
PortalException
- if the user did not have permission to assign
team members
SystemException
- if a system exception occurredpublic static UserGroup updateUserGroup(long userGroupId, String name, String description) throws PortalException, SystemException
updateUserGroup(long,
String, String, ServiceContext)
userGroupId
- the primary key of the user groupname
- the user group's namedescription
- the the user group's description
PortalException
- if a user group with the primary key was not
found, if the new information was invalid, or if the user did
not have permission to update the user group information
SystemException
- if a system exception occurredpublic static UserGroup updateUserGroup(long userGroupId, String name, String description, ServiceContext serviceContext) throws PortalException, SystemException
userGroupId
- the primary key of the user groupname
- the user group's namedescription
- the the user group's descriptionserviceContext
- the service context to be applied (optionally
null
). Can set expando bridge attributes for the
user group.
PortalException
- if a user group with the primary key was not
found, if the new information was invalid, or if the user did not
have permission to update the user group information
SystemException
- if a system exception occurredpublic static UserGroupService getService()
public void setService(UserGroupService service)
|
Liferay 6.2-ce-ga5 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |