com.liferay.portal.service
Interface UserGroupService

All Known Implementing Classes:

UserGroupServiceBaseImpl, UserGroupServiceImpl, UserGroupServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface UserGroupService

The interface for the user group remote service.

Never modify or reference this interface directly. Always use UserGroupServiceUtil to access the user group remote service. Add custom service methods to UserGroupServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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.

See Also:

UserGroupServiceUtil, UserGroupServiceBaseImpl, UserGroupServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

void	addGroupUserGroups(long groupId, long[] userGroupIds)
UserGroup	addUserGroup(String name, String description)
void	deleteUserGroup(long userGroupId)
UserGroup	getUserGroup(long userGroupId)
UserGroup	getUserGroup(String name)
List<UserGroup>	getUserUserGroups(long userId)
void	unsetGroupUserGroups(long groupId, long[] userGroupIds)
UserGroup	updateUserGroup(long userGroupId, String name, String description)

Method Detail

addGroupUserGroups

void addGroupUserGroups(long groupId,
                        long[] userGroupIds)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addUserGroup

UserGroup addUserGroup(String name,
                       String description)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

deleteUserGroup

void deleteUserGroup(long userGroupId)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroup(long userGroupId)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroup(String name)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId)
                                  throws SystemException

Throws:

SystemException

unsetGroupUserGroups

void unsetGroupUserGroups(long groupId,
                          long[] userGroupIds)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

updateUserGroup

UserGroup updateUserGroup(long userGroupId,
                          String name,
                          String description)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException