com.liferay.portal.service
Interface UserGroupService


public interface UserGroupService

View Source

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

This interface defines the service. The default implementation is com.liferay.portal.service.impl.UserGroupServiceImpl. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

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.

Author:
Brian Wing Shun Chan
See Also:
UserGroupServiceFactory, UserGroupServiceUtil

Method Summary
 void addGroupUserGroups(long groupId, long[] userGroupIds)
           
 UserGroup addUserGroup(java.lang.String name, java.lang.String description)
           
 void deleteUserGroup(long userGroupId)
           
 UserGroup getUserGroup(long userGroupId)
           
 UserGroup getUserGroup(java.lang.String name)
           
 java.util.List getUserUserGroups(long userId)
           
 void unsetGroupUserGroups(long groupId, long[] userGroupIds)
           
 UserGroup updateUserGroup(long userGroupId, java.lang.String name, java.lang.String description)
           
 

Method Detail

addGroupUserGroups

public void addGroupUserGroups(long groupId,
                               long[] userGroupIds)
                        throws com.liferay.portal.SystemException,
                               com.liferay.portal.PortalException,
                               java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

addUserGroup

public UserGroup addUserGroup(java.lang.String name,
                              java.lang.String description)
                       throws com.liferay.portal.SystemException,
                              com.liferay.portal.PortalException,
                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

deleteUserGroup

public void deleteUserGroup(long userGroupId)
                     throws com.liferay.portal.SystemException,
                            com.liferay.portal.PortalException,
                            java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserGroup

public UserGroup getUserGroup(long userGroupId)
                       throws com.liferay.portal.SystemException,
                              com.liferay.portal.PortalException,
                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserGroup

public UserGroup getUserGroup(java.lang.String name)
                       throws com.liferay.portal.SystemException,
                              com.liferay.portal.PortalException,
                              java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

getUserUserGroups

public java.util.List getUserUserGroups(long userId)
                                 throws com.liferay.portal.SystemException,
                                        com.liferay.portal.PortalException,
                                        java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

unsetGroupUserGroups

public void unsetGroupUserGroups(long groupId,
                                 long[] userGroupIds)
                          throws com.liferay.portal.SystemException,
                                 com.liferay.portal.PortalException,
                                 java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException

updateUserGroup

public UserGroup updateUserGroup(long userGroupId,
                                 java.lang.String name,
                                 java.lang.String description)
                          throws com.liferay.portal.SystemException,
                                 com.liferay.portal.PortalException,
                                 java.rmi.RemoteException
Throws:
com.liferay.portal.SystemException
com.liferay.portal.PortalException
java.rmi.RemoteException