com.liferay.portal.service
Interface GroupLocalService

All Known Implementing Classes:
GroupLocalServiceWrapper

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

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.GroupLocalServiceImpl}. Modify methods in that class and rerun ServiceBuilder to populate this class and all other generated classes.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

Author:
Brian Wing Shun Chan
See Also:
GroupLocalServiceUtil
Generated:

Method Summary
 Group addGroup(Group group)
           
 Group addGroup(long userId, java.lang.String className, long classPK, long liveGroupId, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active, ServiceContext serviceContext)
           
 Group addGroup(long userId, java.lang.String className, long classPK, java.lang.String name, java.lang.String description, int type, java.lang.String friendlyURL, boolean active, ServiceContext serviceContext)
           
 void addRoleGroups(long roleId, long[] groupIds)
           
 void addUserGroups(long userId, long[] groupIds)
           
 void checkCompanyGroup(long companyId)
           
 void checkSystemGroups(long companyId)
           
 Group createGroup(long groupId)
           
 void deleteGroup(Group group)
           
 void deleteGroup(long groupId)
           
 java.util.List dynamicQuery(DynamicQuery dynamicQuery)
           
 java.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
           
 java.util.List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
           
 long dynamicQueryCount(DynamicQuery dynamicQuery)
           
 Group getCompanyGroup(long companyId)
           
 java.util.List<Group> getCompanyGroups(long companyId, int start, int end)
           
 int getCompanyGroupsCount(long companyId)
           
 Group getFriendlyURLGroup(long companyId, java.lang.String friendlyURL)
           
 Group getGroup(long groupId)
           
 Group getGroup(long companyId, java.lang.String name)
           
 java.util.List<Group> getGroups(int start, int end)
           
 java.util.List<Group> getGroups(long[] groupIds)
           
 int getGroupsCount()
           
 Group getLayoutGroup(long companyId, long plid)
           
 Group getLayoutPrototypeGroup(long companyId, long layoutPrototypeId)
           
 Group getLayoutSetPrototypeGroup(long companyId, long layoutSetPrototypeId)
           
 java.util.List<Group> getNoLayoutsGroups(java.lang.String className, boolean privateLayout, int start, int end)
           
 java.util.List<Group> getNullFriendlyURLGroups()
           
 Group getOrganizationGroup(long companyId, long organizationId)
           
 java.util.List<Group> getOrganizationsGroups(java.util.List<Organization> organizations)
           
 java.util.List<Group> getOrganizationsRelatedGroups(java.util.List<Organization> organizations)
           
 java.util.List<Group> getRoleGroups(long roleId)
           
 Group getStagingGroup(long liveGroupId)
           
 Group getUserGroup(long companyId, long userId)
           
 Group getUserGroupGroup(long companyId, long userGroupId)
           
 java.util.List<Group> getUserGroups(long userId)
           
 java.util.List<Group> getUserGroups(long userId, boolean inherit)
           
 java.util.List<Group> getUserGroups(long userId, boolean inherit, int start, int end)
           
 java.util.List<Group> getUserGroups(long userId, int start, int end)
           
 java.util.List<Group> getUserGroupsGroups(java.util.List<UserGroup> userGroups)
           
 java.util.List<Group> getUserGroupsRelatedGroups(java.util.List<UserGroup> userGroups)
           
 java.util.List<Group> getUserOrganizationsGroups(long userId, int start, int end)
           
 boolean hasRoleGroup(long roleId, long groupId)
           
 boolean hasStagingGroup(long liveGroupId)
           
 boolean hasUserGroup(long userId, long groupId)
           
 java.util.List<Group> search(long companyId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end)
           
 java.util.List<Group> search(long companyId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator obc)
           
 int searchCount(long companyId, java.lang.String name, java.lang.String description, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
           
 void setRoleGroups(long roleId, long[] groupIds)
           
 void unsetRoleGroups(long roleId, long[] groupIds)
           
 void unsetUserGroups(long userId, long[] groupIds)
           
 void updateAsset(long userId, Group group, long[] assetCategoryIds, java.lang.String[] assetTagNames)
           
 Group updateFriendlyURL(long groupId, java.lang.String friendlyURL)
           
 Group updateGroup(Group group)
           
 Group updateGroup(Group group, boolean merge)
           
 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, ServiceContext serviceContext)
           
 Group updateWorkflow(long groupId, boolean workflowEnabled, int workflowStages, java.lang.String workflowRoleNames)
           
 

Method Detail

addGroup

Group addGroup(Group group)
               throws SystemException
Throws:
SystemException

createGroup

Group createGroup(long groupId)

deleteGroup

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

deleteGroup

void deleteGroup(Group group)
                 throws SystemException
Throws:
SystemException

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException
Throws:
SystemException

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                            int start,
                            int end)
                            throws SystemException
Throws:
SystemException

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                            int start,
                            int end,
                            OrderByComparator orderByComparator)
                            throws SystemException
Throws:
SystemException

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Throws:
SystemException

getGroup

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

getGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getGroups(int start,
                                                                         int end)
                                throws SystemException
Throws:
SystemException

getGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupsCount()
                   throws SystemException
Throws:
SystemException

updateGroup

Group updateGroup(Group group)
                  throws SystemException
Throws:
SystemException

updateGroup

Group updateGroup(Group group,
                  boolean merge)
                  throws SystemException
Throws:
SystemException

addGroup

Group addGroup(long userId,
               java.lang.String className,
               long classPK,
               java.lang.String name,
               java.lang.String description,
               int type,
               java.lang.String friendlyURL,
               boolean active,
               ServiceContext serviceContext)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

addGroup

Group addGroup(long userId,
               java.lang.String className,
               long classPK,
               long liveGroupId,
               java.lang.String name,
               java.lang.String description,
               int type,
               java.lang.String friendlyURL,
               boolean active,
               ServiceContext serviceContext)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

addRoleGroups

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

addUserGroups

void addUserGroups(long userId,
                   long[] groupIds)
                   throws SystemException
Throws:
SystemException

checkCompanyGroup

void checkCompanyGroup(long companyId)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

checkSystemGroups

void checkSystemGroups(long companyId)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

getCompanyGroup

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

getCompanyGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getCompanyGroups(long companyId,
                                                                                int start,
                                                                                int end)
                                       throws SystemException
Throws:
SystemException

getCompanyGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyGroupsCount(long companyId)
                          throws SystemException
Throws:
SystemException

getFriendlyURLGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Group getFriendlyURLGroup(long companyId,
                                                                   java.lang.String friendlyURL)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getGroup

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

getGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getGroups(long[] groupIds)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

getLayoutGroup

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

getLayoutPrototypeGroup

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

getLayoutSetPrototypeGroup

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

getNoLayoutsGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getNoLayoutsGroups(java.lang.String className,
                                                                                  boolean privateLayout,
                                                                                  int start,
                                                                                  int end)
                                         throws SystemException
Throws:
SystemException

getNullFriendlyURLGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getNullFriendlyURLGroups()
                                               throws SystemException
Throws:
SystemException

getOrganizationGroup

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

getOrganizationsGroups

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

getOrganizationsRelatedGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getOrganizationsRelatedGroups(java.util.List<Organization> organizations)
                                                    throws SystemException
Throws:
SystemException

getRoleGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getRoleGroups(long roleId)
                                    throws SystemException
Throws:
SystemException

getStagingGroup

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

getUserGroup

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

getUserGroupGroup

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

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroups(long userId)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroups(long userId,
                                                                             boolean inherit)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getUserGroups

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

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroups(long userId,
                                                                             boolean inherit,
                                                                             int start,
                                                                             int end)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

getUserGroupsGroups

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

getUserGroupsRelatedGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> getUserGroupsRelatedGroups(java.util.List<UserGroup> userGroups)
                                                 throws SystemException
Throws:
SystemException

getUserOrganizationsGroups

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

hasRoleGroup

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

hasStagingGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasStagingGroup(long liveGroupId)
                        throws SystemException
Throws:
SystemException

hasUserGroup

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

search

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

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Group> search(long companyId,
                                                                      java.lang.String name,
                                                                      java.lang.String description,
                                                                      java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                      int start,
                                                                      int end,
                                                                      OrderByComparator obc)
                             throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         java.lang.String name,
                                                         java.lang.String description,
                                                         java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
                throws SystemException
Throws:
SystemException

setRoleGroups

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

unsetRoleGroups

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

unsetUserGroups

void unsetUserGroups(long userId,
                     long[] groupIds)
                     throws SystemException
Throws:
SystemException

updateAsset

void updateAsset(long userId,
                 Group group,
                 long[] assetCategoryIds,
                 java.lang.String[] assetTagNames)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

updateFriendlyURL

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

updateGroup

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

updateGroup

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

updateWorkflow

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