com.liferay.portal.service
Interface GroupService


public interface GroupService

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.GroupServiceImpl. 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:
GroupServiceFactory, GroupServiceUtil

Method Summary
 Group addGroup(long liveGroupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active)
           
 Group addGroup(java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active)
           
 void addRoleGroups(long roleId, long[] groupIds)
           
 void deleteGroup(long groupId)
           
 Group getGroup(long groupId)
           
 Group getGroup(long companyId, java.lang.String name)
           
 java.util.List getOrganizationsGroups(java.util.List organizations)
           
 java.util.List getUserGroupsGroups(java.util.List userGroups)
           
 boolean hasUserGroup(long userId, long groupId)
           
 java.util.List search(long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params, int begin, int end)
           
 int searchCount(long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params)
           
 void setRoleGroups(long roleId, long[] groupIds)
           
 void unsetRoleGroups(long roleId, long[] groupIds)
           
 Group updateGroup(long groupId, java.lang.String typeSettings)
           
 Group updateGroup(long groupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active)
           
 

Method Detail

addGroup

public Group addGroup(java.lang.String name,
                      java.lang.String description,
                      int type,
                      java.lang.String friendlyURL,
                      boolean active)
               throws java.rmi.RemoteException,
                      com.liferay.portal.SystemException,
                      com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addGroup

public Group addGroup(long liveGroupId,
                      java.lang.String name,
                      java.lang.String description,
                      int type,
                      java.lang.String friendlyURL,
                      boolean active)
               throws java.rmi.RemoteException,
                      com.liferay.portal.SystemException,
                      com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

addRoleGroups

public void addRoleGroups(long roleId,
                          long[] groupIds)
                   throws java.rmi.RemoteException,
                          com.liferay.portal.SystemException,
                          com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

deleteGroup

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

getGroup

public Group getGroup(long groupId)
               throws java.rmi.RemoteException,
                      com.liferay.portal.SystemException,
                      com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getGroup

public Group getGroup(long companyId,
                      java.lang.String name)
               throws java.rmi.RemoteException,
                      com.liferay.portal.SystemException,
                      com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getOrganizationsGroups

public java.util.List getOrganizationsGroups(java.util.List organizations)
                                      throws java.rmi.RemoteException,
                                             com.liferay.portal.SystemException,
                                             com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

getUserGroupsGroups

public java.util.List getUserGroupsGroups(java.util.List userGroups)
                                   throws java.rmi.RemoteException,
                                          com.liferay.portal.SystemException,
                                          com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

hasUserGroup

public boolean hasUserGroup(long userId,
                            long groupId)
                     throws java.rmi.RemoteException,
                            com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException

search

public java.util.List search(long companyId,
                             java.lang.String name,
                             java.lang.String description,
                             java.lang.String[] params,
                             int begin,
                             int end)
                      throws java.rmi.RemoteException,
                             com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException

searchCount

public int searchCount(long companyId,
                       java.lang.String name,
                       java.lang.String description,
                       java.lang.String[] params)
                throws java.rmi.RemoteException,
                       com.liferay.portal.SystemException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException

setRoleGroups

public void setRoleGroups(long roleId,
                          long[] groupIds)
                   throws java.rmi.RemoteException,
                          com.liferay.portal.SystemException,
                          com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

unsetRoleGroups

public void unsetRoleGroups(long roleId,
                            long[] groupIds)
                     throws java.rmi.RemoteException,
                            com.liferay.portal.SystemException,
                            com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateGroup

public Group updateGroup(long groupId,
                         java.lang.String name,
                         java.lang.String description,
                         int type,
                         java.lang.String friendlyURL,
                         boolean active)
                  throws java.rmi.RemoteException,
                         com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException

updateGroup

public Group updateGroup(long groupId,
                         java.lang.String typeSettings)
                  throws java.rmi.RemoteException,
                         com.liferay.portal.SystemException,
                         com.liferay.portal.PortalException
Throws:
java.rmi.RemoteException
com.liferay.portal.SystemException
com.liferay.portal.PortalException