Liferay 6.0.5

com.liferay.portal.service
Interface GroupService

All Known Implementing Classes:
GroupServiceBaseImpl, GroupServiceImpl, GroupServiceWrapper

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

The interface for the group remote service.

Never modify or reference this interface directly. Always use GroupServiceUtil to access the group remote service. Add custom service methods to GroupServiceImpl 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:
GroupServiceUtil, GroupServiceBaseImpl, GroupServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 Group addGroup(long liveGroupId, String name, String description, int type, String friendlyURL, boolean active, ServiceContext serviceContext)
           
 Group addGroup(String name, String description, int type, String friendlyURL, boolean active, ServiceContext serviceContext)
           
 void addRoleGroups(long roleId, long[] groupIds)
           
 void deleteGroup(long groupId)
           
 Group getGroup(long groupId)
           
 Group getGroup(long companyId, String name)
           
 List<Group> getManageableGroups(String actionId, int max)
           
 List<Group> getOrganizationsGroups(List<Organization> organizations)
           
 Group getUserGroup(long companyId, long userId)
           
 List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
           
 List<Group> getUserOrganizationsGroups(long userId, int start, int end)
           
 boolean hasUserGroup(long userId, long groupId)
           
 List<Group> search(long companyId, String name, String description, String[] params, int start, int end)
           
 int searchCount(long companyId, String name, String description, String[] params)
           
 void setRoleGroups(long roleId, long[] groupIds)
           
 void unsetRoleGroups(long roleId, long[] groupIds)
           
 Group updateFriendlyURL(long groupId, String friendlyURL)
           
 Group updateGroup(long groupId, String typeSettings)
           
 Group updateGroup(long groupId, String name, String description, int type, String friendlyURL, boolean active, ServiceContext serviceContext)
           
 Group updateWorkflow(long groupId, boolean workflowEnabled, int workflowStages, String workflowRoleNames)
           
 

Method Detail

addGroup

Group addGroup(String name,
               String description,
               int type,
               String friendlyURL,
               boolean active,
               ServiceContext serviceContext)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

addGroup

Group addGroup(long liveGroupId,
               String name,
               String description,
               int type,
               String friendlyURL,
               boolean active,
               ServiceContext serviceContext)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

addRoleGroups

void addRoleGroups(long roleId,
                   long[] groupIds)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

deleteGroup

void deleteGroup(long groupId)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

getGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group getGroup(long groupId)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

getGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group getGroup(long companyId,
                                                        String name)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

getManageableGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Group> getManageableGroups(String actionId,
                                                                         int max)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getOrganizationsGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Group> getOrganizationsGroups(List<Organization> organizations)

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group getUserGroup(long companyId,
                                                            long userId)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

getUserGroupsGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Group> getUserGroupsGroups(List<UserGroup> userGroups)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getUserOrganizationsGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Group> getUserOrganizationsGroups(long userId,
                                                                                int start,
                                                                                int end)
                                       throws PortalException,
                                              SystemException
Throws:
PortalException
SystemException

hasUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasUserGroup(long userId,
                                                              long groupId)
                     throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<Group> search(long companyId,
                                                            String name,
                                                            String description,
                                                            String[] params,
                                                            int start,
                                                            int end)
                   throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         String name,
                                                         String description,
                                                         String[] params)
                throws SystemException
Throws:
SystemException

setRoleGroups

void setRoleGroups(long roleId,
                   long[] groupIds)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

unsetRoleGroups

void unsetRoleGroups(long roleId,
                     long[] groupIds)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

updateFriendlyURL

Group updateFriendlyURL(long groupId,
                        String friendlyURL)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

updateGroup

Group updateGroup(long groupId,
                  String name,
                  String description,
                  int type,
                  String friendlyURL,
                  boolean active,
                  ServiceContext serviceContext)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

updateGroup

Group updateGroup(long groupId,
                  String typeSettings)
                  throws PortalException,
                         SystemException
Throws:
PortalException
SystemException

updateWorkflow

Group updateWorkflow(long groupId,
                     boolean workflowEnabled,
                     int workflowStages,
                     String workflowRoleNames)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5