Liferay 6.0-ee-sp2

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)
           
 void addTeamUserGroups(long teamId, long[] userGroupIds)
           
 UserGroup addUserGroup(long userId, long companyId, String name, String description)
           
 UserGroup addUserGroup(UserGroup userGroup)
          Adds the user group to the database.
 void clearUserUserGroups(long userId)
           
 void copyUserGroupLayouts(long[] userGroupIds, long userId)
           
 void copyUserGroupLayouts(long userGroupId, long userId)
           
 void copyUserGroupLayouts(long userGroupId, long[] userIds)
           
 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.
 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)
           
 List<UserGroup> getUserGroups(int start, int end)
          Returns a range of all the user groups.
 List<UserGroup> getUserGroups(long companyId)
           
 List<UserGroup> getUserGroups(long[] userGroupIds)
           
 int getUserGroupsCount()
          Returns the number of user groups.
 List<UserGroup> getUserUserGroups(long userId)
           
 boolean hasGroupUserGroup(long groupId, long userGroupId)
           
 boolean hasTeamUserGroup(long teamId, long userGroupId)
           
 List<UserGroup> search(long companyId, String name, String description, LinkedHashMap<String,Object> params, int start, int end, OrderByComparator obc)
           
 int searchCount(long companyId, String name, String description, LinkedHashMap<String,Object> params)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setUserUserGroups(long userId, long[] userGroupIds)
           
 void unsetGroupUserGroups(long groupId, long[] userGroupIds)
           
 void unsetTeamUserGroups(long teamId, long[] userGroupIds)
           
 UserGroup updateUserGroup(long companyId, long userGroupId, String name, String description)
           
 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

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
Throws:
SystemException

addTeamUserGroups

void addTeamUserGroups(long teamId,
                       long[] userGroupIds)
                       throws SystemException
Throws:
SystemException

addUserGroup

UserGroup addUserGroup(long userId,
                       long companyId,
                       String name,
                       String description)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

clearUserUserGroups

void clearUserUserGroups(long userId)
                         throws SystemException
Throws:
SystemException

copyUserGroupLayouts

void copyUserGroupLayouts(long userGroupId,
                          long[] userIds)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

copyUserGroupLayouts

void copyUserGroupLayouts(long[] userGroupIds,
                          long userId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

copyUserGroupLayouts

void copyUserGroupLayouts(long userGroupId,
                          long userId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getUserGroup

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

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(long companyId)
                              throws SystemException
Throws:
SystemException

getUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserGroups(long[] userGroupIds)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

getUserUserGroups

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<UserGroup> getUserUserGroups(long userId)
                                  throws SystemException
Throws:
SystemException

hasGroupUserGroup

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

hasTeamUserGroup

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasTeamUserGroup(long teamId,
                                                                  long userGroupId)
                         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
Throws:
SystemException

searchCount

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

setUserUserGroups

void setUserUserGroups(long userId,
                       long[] userGroupIds)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

unsetGroupUserGroups

void unsetGroupUserGroups(long groupId,
                          long[] userGroupIds)
                          throws SystemException
Throws:
SystemException

unsetTeamUserGroups

void unsetTeamUserGroups(long teamId,
                         long[] userGroupIds)
                         throws SystemException
Throws:
SystemException

updateUserGroup

UserGroup updateUserGroup(long companyId,
                          long userGroupId,
                          String name,
                          String description)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

Liferay 6.0-ee-sp2