Liferay 6.1.10-ee-ga1

com.liferay.portal.service
Interface UserGroupLocalService

All Superinterfaces:
PersistedModelLocalService
All Known Implementing Classes:
UserGroupLocalServiceWrapper

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

The interface for the user group local service.

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.

See Also:
UserGroupLocalServiceUtil, UserGroupLocalServiceBaseImpl, com.liferay.portal.service.impl.UserGroupLocalServiceImpl

Method Summary
 void addGroupUserGroups(long groupId, long[] userGroupIds)
          Adds the user groups to the group.
 void addTeamUserGroups(long teamId, long[] userGroupIds)
          Adds the user groups to the team.
 UserGroup addUserGroup(long userId, long companyId, String name, String description)
          Adds a user group.
 UserGroup addUserGroup(UserGroup userGroup)
          Adds the user group to the database.
 void clearUserUserGroups(long userId)
          Clears all associations between the user and its user groups and clears the permissions cache.
 void copyUserGroupLayouts(long[] userGroupIds, long userId)
          Deprecated.  
 void copyUserGroupLayouts(long userGroupId, long userId)
          Deprecated.  
 void copyUserGroupLayouts(long userGroupId, long[] userIds)
          Deprecated.  
 UserGroup createUserGroup(long userGroupId)
          Creates a new user group with the primary key.
 void deleteUserGroup(long userGroupId)
          Deletes the user group with the primary key from the database.
 void deleteUserGroup(UserGroup userGroup)
          Deletes the user group from the database.
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 UserGroup fetchUserGroup(long userGroupId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 UserGroup getUserGroup(long userGroupId)
          Returns the user group with the primary key.
 UserGroup getUserGroup(long companyId, String name)
          Returns the user group with the name.
 List<UserGroup> getUserGroups(int start, int end)
          Returns a range of all the user groups.
 List<UserGroup> getUserGroups(long companyId)
          Returns all the user groups belonging to the company.
 List<UserGroup> getUserGroups(long[] userGroupIds)
          Returns all the user groups with the primary keys.
 int getUserGroupsCount()
          Returns the number of user groups.
 List<UserGroup> getUserUserGroups(long userId)
          Returns all the user groups to which the user belongs.
 boolean hasGroupUserGroup(long groupId, long userGroupId)
          Returns true if the user group is associated with the group.
 boolean hasTeamUserGroup(long teamId, long userGroupId)
          Returns true if the user group belongs to the team.
 List<UserGroup> search(long companyId, String keywords, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
           
 List<UserGroup> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
          Returns an ordered range of all the user groups that match the name and description.
 int searchCount(long companyId, String keywords, LinkedHashMap<String,Object> params)
           
 int searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params)
          Returns the number of user groups that match the name and description.
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setUserUserGroups(long userId, long[] userGroupIds)
          Sets the user groups associated with the user copying the user group layouts and removing and adding user group associations for the user as necessary.
 void unsetGroupUserGroups(long groupId, long[] userGroupIds)
          Removes the user groups from the group.
 void unsetTeamUserGroups(long teamId, long[] userGroupIds)
          Removes the user groups from the team.
 UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description)
          Updates the user group.
 UserGroup updateUserGroup(UserGroup userGroup)
          Updates the user group in the database or adds it if it does not yet exist.
 UserGroup updateUserGroup(UserGroup userGroup, boolean merge)
          Updates the user group in the database or adds it if it does not yet exist.
 

Method Detail

addUserGroup

UserGroup addUserGroup(UserGroup userGroup)
                       throws SystemException
Adds the user group to the database. Also notifies the appropriate model listeners.

Parameters:
userGroup - the user group
Returns:
the user group that was added
Throws:
SystemException - if a system exception occurred

createUserGroup

UserGroup createUserGroup(long userGroupId)
Creates a new user group with the primary key. Does not add the user group to the database.

Parameters:
userGroupId - the primary key for the new user group
Returns:
the new user group

deleteUserGroup

void deleteUserGroup(long userGroupId)
                     throws PortalException,
                            SystemException
Deletes the user group with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
userGroupId - the primary key of the user group
Throws:
PortalException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

deleteUserGroup

void deleteUserGroup(UserGroup userGroup)
                     throws PortalException,
                            SystemException
Deletes the user group from the database. Also notifies the appropriate model listeners.

Parameters:
userGroup - the user group
Throws:
PortalException
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup fetchUserGroup(long userGroupId)
                         throws SystemException
Throws:
SystemException

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroup(long userGroupId)
                       throws PortalException,
                              SystemException
Returns the user group with the primary key.

Parameters:
userGroupId - the primary key of the user group
Returns:
the user group
Throws:
PortalException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(int start,
                                                                       int end)
                              throws SystemException
Returns a range of all the user groups.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of user groups
end - the upper bound of the range of user groups (not inclusive)
Returns:
the range of user groups
Throws:
SystemException - if a system exception occurred

getUserGroupsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserGroupsCount()
                       throws SystemException
Returns the number of user groups.

Returns:
the number of user groups
Throws:
SystemException - if a system exception occurred

updateUserGroup

UserGroup updateUserGroup(UserGroup userGroup)
                          throws SystemException
Updates the user group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
userGroup - the user group
Returns:
the user group that was updated
Throws:
SystemException - if a system exception occurred

updateUserGroup

UserGroup updateUserGroup(UserGroup userGroup,
                          boolean merge)
                          throws SystemException
Updates the user group in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
userGroup - the user group
merge - whether to merge the user group with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the user group that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addGroupUserGroups

void addGroupUserGroups(long groupId,
                        long[] userGroupIds)
                        throws SystemException
Adds the user groups to the group.

Parameters:
groupId - the primary key of the group
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

addTeamUserGroups

void addTeamUserGroups(long teamId,
                       long[] userGroupIds)
                       throws SystemException
Adds the user groups to the team.

Parameters:
teamId - the primary key of the team
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

addUserGroup

UserGroup addUserGroup(long userId,
                       long companyId,
                       String name,
                       String description)
                       throws PortalException,
                              SystemException
Adds a user group.

This method handles the creation and bookkeeping of the user group, including its resources, metadata, and internal data structures. It is not necessary to make subsequent calls to setup default groups and resources for the user group.

Parameters:
userId - the primary key of the user
companyId - the primary key of the user group's company
name - the user group's name
description - the user group's description
Returns:
the user group
Throws:
PortalException - if the user group's information was invalid
SystemException - if a system exception occurred

clearUserUserGroups

void clearUserUserGroups(long userId)
                         throws SystemException
Clears all associations between the user and its user groups and clears the permissions cache.

This method is called from deleteUserGroup(UserGroup).

Parameters:
userId - the primary key of the user
Throws:
SystemException - if a system exception occurred

copyUserGroupLayouts

void copyUserGroupLayouts(long userGroupId,
                          long[] userIds)
                          throws PortalException,
                                 SystemException
Deprecated. 

Copies the user group's layouts to the users who are not already members of the user group.

Parameters:
userGroupId - the primary key of the user group
userIds - the primary keys of the users
Throws:
PortalException - if any one of the users could not be found or if a portal exception occurred
SystemException - if a system exception occurred

copyUserGroupLayouts

void copyUserGroupLayouts(long[] userGroupIds,
                          long userId)
                          throws PortalException,
                                 SystemException
Deprecated. 

Copies the user groups' layouts to the user.

Parameters:
userGroupIds - the primary keys of the user groups
userId - the primary key of the user
Throws:
PortalException - if a user with the primary key could not be found or if a portal exception occurred
SystemException - if a system exception occurred

copyUserGroupLayouts

void copyUserGroupLayouts(long userGroupId,
                          long userId)
                          throws PortalException,
                                 SystemException
Deprecated. 

Copies the user group's layout to the user.

Parameters:
userGroupId - the primary key of the user group
userId - the primary key of the user
Throws:
PortalException - if a user with the primary key could not be found or if a portal exception occurred
SystemException - if a system exception occurred

getUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
UserGroup getUserGroup(long companyId,
                                                                String name)
                       throws PortalException,
                              SystemException
Returns the user group with the name.

Parameters:
companyId - the primary key of the user group's company
name - the user group's name
Returns:
Returns the user group with the name
Throws:
PortalException - if a user group with the name could not be found
SystemException - if a system exception occurred

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(long companyId)
                              throws SystemException
Returns all the user groups belonging to the company.

Parameters:
companyId - the primary key of the user groups' company
Returns:
the user groups belonging to the company
Throws:
SystemException - if a system exception occurred

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(long[] userGroupIds)
                              throws PortalException,
                                     SystemException
Returns all the user groups with the primary keys.

Parameters:
userGroupIds - the primary keys of the user groups
Returns:
the user groups with the primary keys
Throws:
PortalException - if any one of the user groups could not be found
SystemException - if a system exception occurred

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId)
                                  throws SystemException
Returns all the user groups to which the user belongs.

Parameters:
userId - the primary key of the user
Returns:
the user groups to which the user belongs
Throws:
SystemException - if a system exception occurred

hasGroupUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasGroupUserGroup(long groupId,
                                                                   long userGroupId)
                          throws SystemException
Returns true if the user group is associated with the group.

Parameters:
groupId - the primary key of the group
userGroupId - the primary key of the user group
Returns:
true if the user group belongs to the group; false otherwise
Throws:
SystemException - if a system exception occurred

hasTeamUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasTeamUserGroup(long teamId,
                                                                  long userGroupId)
                         throws SystemException
Returns true if the user group belongs to the team.

Parameters:
teamId - the primary key of the team
userGroupId - the primary key of the user group
Returns:
true if the user group belongs to the team; false otherwise
Throws:
SystemException - if a system exception occurred

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> search(long companyId,
                                                                String keywords,
                                                                LinkedHashMap<String,Object> params,
                                                                int start,
                                                                int end,
                                                                OrderByComparator obc)
                       throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> search(long companyId,
                                                                String name,
                                                                String description,
                                                                LinkedHashMap<String,Object> params,
                                                                int start,
                                                                int end,
                                                                OrderByComparator obc)
                       throws SystemException
Returns an ordered range of all the user groups that match the name and description.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
companyId - the primary key of the user group's company
name - the user group's name (optionally null)
description - the user group's description (optionally null)
params - the finder params (optionally null). For more information see UserGroupFinder
start - the lower bound of the range of user groups to return
end - the upper bound of the range of user groups to return (not inclusive)
obc - the comparator to order the user groups (optionally null)
Returns:
the matching user groups ordered by comparator obc
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupFinder

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         String keywords,
                                                         LinkedHashMap<String,Object> params)
                throws SystemException
Throws:
SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         String name,
                                                         String description,
                                                         LinkedHashMap<String,Object> params)
                throws SystemException
Returns the number of user groups that match the name and description.

Parameters:
companyId - the primary key of the user group's company
name - the user group's name (optionally null)
description - the user group's description (optionally null)
params - the finder params (optionally null). For more information see UserGroupFinder
Returns:
the number of matching user groups
Throws:
SystemException - if a system exception occurred
See Also:
UserGroupFinder

setUserUserGroups

void setUserUserGroups(long userId,
                       long[] userGroupIds)
                       throws PortalException,
                              SystemException
Sets the user groups associated with the user copying the user group layouts and removing and adding user group associations for the user as necessary.

Parameters:
userId - the primary key of the user
userGroupIds - the primary keys of the user groups
Throws:
PortalException - if a portal exception occurred
SystemException - if a system exception occurred

unsetGroupUserGroups

void unsetGroupUserGroups(long groupId,
                          long[] userGroupIds)
                          throws SystemException
Removes the user groups from the group.

Parameters:
groupId - the primary key of the group
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

unsetTeamUserGroups

void unsetTeamUserGroups(long teamId,
                         long[] userGroupIds)
                         throws SystemException
Removes the user groups from the team.

Parameters:
teamId - the primary key of the team
userGroupIds - the primary keys of the user groups
Throws:
SystemException - if a system exception occurred

updateUserGroup

UserGroup updateUserGroup(long companyId,
                          long userGroupId,
                          String name,
                          String description)
                          throws PortalException,
                                 SystemException
Updates the user group.

Parameters:
companyId - the primary key of the user group's company
userGroupId - the primary key of the user group
name - the user group's name
description - the user group's description
Returns:
the user group
Throws:
PortalException - if a user group with the primary key could not be found or if the new information was invalid
SystemException - if a system exception occurred

Liferay 6.1.10-ee-ga1