Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service
Interface GroupService

@Transactional(rollbackFor={com.liferay.portal.PortalException.class,com.liferay.portal.SystemException.class})
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:
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<Group> getManageableGroups(long userId, java.lang.String actionId)
           
 java.util.List<Group> getOrganizationsGroups(java.util.List<Organization> organizations)
           
 Group getUserGroup(long companyId, long userId)
           
 java.util.List<Group> getUserGroupsGroups(java.util.List<UserGroup> userGroups)
           
 java.util.List<Group> getUserOrganizationsGroups(long userId, int start, int end)
           
 boolean hasUserGroup(long userId, long groupId)
           
 java.util.List<Group> search(long companyId, java.lang.String name, java.lang.String description, java.lang.String[] params, int start, 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 updateFriendlyURL(long groupId, java.lang.String friendlyURL)
           
 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)
           
 Group updateWorkflow(long groupId, boolean workflowEnabled, int workflowStages, java.lang.String workflowRoleNames)
           
 

Method Detail

addGroup

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

addGroup

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

addRoleGroups

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

deleteGroup

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

getGroup

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

getGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group getGroup(long companyId,
                             java.lang.String name)
               throws com.liferay.portal.PortalException,
                      com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getManageableGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getManageableGroups(long userId,
                                                        java.lang.String actionId)
                                          throws com.liferay.portal.PortalException,
                                                 com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getOrganizationsGroups

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

getUserGroup

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

getUserGroupsGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroupsGroups(java.util.List<UserGroup> userGroups)

getUserOrganizationsGroups

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

hasUserGroup

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

search

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

searchCount

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

setRoleGroups

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

unsetRoleGroups

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

updateFriendlyURL

Group updateFriendlyURL(long groupId,
                        java.lang.String friendlyURL)
                        throws com.liferay.portal.PortalException,
                               com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

updateGroup

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

updateGroup

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

updateWorkflow

Group updateWorkflow(long groupId,
                     boolean workflowEnabled,
                     int workflowStages,
                     java.lang.String workflowRoleNames)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD