|
Liferay 6.1.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
@JSONWebService
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface UserGroupServiceThe interface for the user group remote service.
This is a remote service. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.
UserGroupServiceUtil,
UserGroupServiceBaseImpl,
UserGroupServiceImpl| Method Summary | |
|---|---|
void |
addGroupUserGroups(long groupId,
long[] userGroupIds)
Adds the user groups to the group. |
void |
addTeamUserGroups(long teamId,
long[] userGroupIds)
Adds the user groups to the team |
UserGroup |
addUserGroup(String name,
String description,
long publicLayoutSetPrototypeId,
long privateLayoutSetPrototypeId)
Adds a user group. |
void |
deleteUserGroup(long userGroupId)
Deletes the user group. |
UserGroup |
getUserGroup(long userGroupId)
Returns the user group with the primary key. |
UserGroup |
getUserGroup(String name)
Returns the user group with the name. |
List<UserGroup> |
getUserUserGroups(long userId)
Returns all the user groups to which the user belongs. |
void |
unsetGroupUserGroups(long groupId,
long[] userGroupIds)
Removes the user groups from the group. |
void |
unsetTeamUserGroups(long teamId,
long[] userGroupIds)
Removes the user groups from the team. |
UserGroup |
updateUserGroup(long userGroupId,
String name,
String description,
long publicLayoutSetPrototypeId,
long privateLayoutSetPrototypeId)
Updates the user group. |
| Method Detail |
|---|
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 occurred
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 occurred
UserGroup addUserGroup(String name,
String description,
long publicLayoutSetPrototypeId,
long privateLayoutSetPrototypeId)
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 descriptionpublicLayoutSetPrototypeId - the primary key of the user group's
public layout setprivateLayoutSetPrototypeId - the primary key of the user group's
private layout set
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 occurred
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 occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
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 occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
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 occurred
@Transactional(propagation=SUPPORTS,
readOnly=true)
List<UserGroup> getUserUserGroups(long userId)
throws SystemException
userId - the primary key of the user
SystemException - if a system exception occurred
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 occurred
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 occurred
UserGroup updateUserGroup(long userGroupId,
String name,
String description,
long publicLayoutSetPrototypeId,
long privateLayoutSetPrototypeId)
throws PortalException,
SystemException
userGroupId - the primary key of the user groupname - the user group's namedescription - the the user group's descriptionpublicLayoutSetPrototypeId - the primary key of the user group's
public layout setprivateLayoutSetPrototypeId - the primary key of the user group's
private layout set
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 occurred
|
Liferay 6.1.0-ce-b4 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||