Liferay 6.0.5

com.liferay.portal.service.persistence
Interface UserGroupPersistence

All Superinterfaces:
BasePersistence<UserGroup>
All Known Implementing Classes:
UserGroupPersistenceImpl

public interface UserGroupPersistence
extends BasePersistence<UserGroup>

The persistence interface for the user group service.

Never modify or reference this interface directly. Always use UserGroupUtil to access the user group persistence. Modify service.xml and rerun ServiceBuilder to regenerate this interface.

Caching information and settings can be found in portal.properties

See Also:
UserGroupPersistenceImpl, UserGroupUtil
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 void addGroup(long pk, Group group)
          Adds an association between the user group and the group.
 void addGroup(long pk, long groupPK)
          Adds an association between the user group and the group.
 void addGroups(long pk, List<Group> groups)
          Adds an association between the user group and the groups.
 void addGroups(long pk, long[] groupPKs)
          Adds an association between the user group and the groups.
 void addUser(long pk, long userPK)
          Adds an association between the user group and the user.
 void addUser(long pk, User user)
          Adds an association between the user group and the user.
 void addUsers(long pk, List<User> users)
          Adds an association between the user group and the users.
 void addUsers(long pk, long[] userPKs)
          Adds an association between the user group and the users.
 void cacheResult(List<UserGroup> userGroups)
          Caches the user groups in the entity cache if it is enabled.
 void cacheResult(UserGroup userGroup)
          Caches the user group in the entity cache if it is enabled.
 void clearGroups(long pk)
          Clears all associations between the user group and its groups.
 void clearUsers(long pk)
          Clears all associations between the user group and its users.
 boolean containsGroup(long pk, long groupPK)
          Determines whether the group is associated with the user group.
 boolean containsGroups(long pk)
          Determines whether the user group has any groups associated with it.
 boolean containsUser(long pk, long userPK)
          Determines whether the user is associated with the user group.
 boolean containsUsers(long pk)
          Determines whether the user group has any users associated with it.
 int countAll()
          Counts all the user groups.
 int countByC_N(long companyId, String name)
          Counts all the user groups where companyId = ? and name = ?.
 int countByC_P(long companyId, long parentUserGroupId)
          Counts all the user groups where companyId = ? and parentUserGroupId = ?.
 int countByCompanyId(long companyId)
          Counts all the user groups where companyId = ?.
 UserGroup create(long userGroupId)
          Creates a new user group with the primary key.
 UserGroup fetchByC_N(long companyId, String name)
          Finds the user group where companyId = ? and name = ? or returns null if it could not be found.
 UserGroup fetchByC_N(long companyId, String name, boolean retrieveFromCache)
          Finds the user group where companyId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
 UserGroup fetchByPrimaryKey(long userGroupId)
          Finds the user group with the primary key or returns null if it could not be found.
 List<UserGroup> findAll()
          Finds all the user groups.
 List<UserGroup> findAll(int start, int end)
          Finds a range of all the user groups.
 List<UserGroup> findAll(int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the user groups.
 UserGroup findByC_N(long companyId, String name)
          Finds the user group where companyId = ? and name = ? or throws a NoSuchUserGroupException if it could not be found.
 UserGroup findByC_P_First(long companyId, long parentUserGroupId, OrderByComparator orderByComparator)
          Finds the first user group in the ordered set where companyId = ? and parentUserGroupId = ?.
 UserGroup findByC_P_Last(long companyId, long parentUserGroupId, OrderByComparator orderByComparator)
          Finds the last user group in the ordered set where companyId = ? and parentUserGroupId = ?.
 UserGroup[] findByC_P_PrevAndNext(long userGroupId, long companyId, long parentUserGroupId, OrderByComparator orderByComparator)
          Finds the user groups before and after the current user group in the ordered set where companyId = ? and parentUserGroupId = ?.
 List<UserGroup> findByC_P(long companyId, long parentUserGroupId)
          Finds all the user groups where companyId = ? and parentUserGroupId = ?.
 List<UserGroup> findByC_P(long companyId, long parentUserGroupId, int start, int end)
          Finds a range of all the user groups where companyId = ? and parentUserGroupId = ?.
 List<UserGroup> findByC_P(long companyId, long parentUserGroupId, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the user groups where companyId = ? and parentUserGroupId = ?.
 UserGroup findByCompanyId_First(long companyId, OrderByComparator orderByComparator)
          Finds the first user group in the ordered set where companyId = ?.
 UserGroup findByCompanyId_Last(long companyId, OrderByComparator orderByComparator)
          Finds the last user group in the ordered set where companyId = ?.
 UserGroup[] findByCompanyId_PrevAndNext(long userGroupId, long companyId, OrderByComparator orderByComparator)
          Finds the user groups before and after the current user group in the ordered set where companyId = ?.
 List<UserGroup> findByCompanyId(long companyId)
          Finds all the user groups where companyId = ?.
 List<UserGroup> findByCompanyId(long companyId, int start, int end)
          Finds a range of all the user groups where companyId = ?.
 List<UserGroup> findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator)
          Finds an ordered range of all the user groups where companyId = ?.
 UserGroup findByPrimaryKey(long userGroupId)
          Finds the user group with the primary key or throws a NoSuchUserGroupException if it could not be found.
 List<Group> getGroups(long pk)
          Gets all the groups associated with the user group.
 List<Group> getGroups(long pk, int start, int end)
          Gets a range of all the groups associated with the user group.
 List<Group> getGroups(long pk, int start, int end, OrderByComparator orderByComparator)
          Gets an ordered range of all the groups associated with the user group.
 int getGroupsSize(long pk)
          Gets the number of groups associated with the user group.
 List<User> getUsers(long pk)
          Gets all the users associated with the user group.
 List<User> getUsers(long pk, int start, int end)
          Gets a range of all the users associated with the user group.
 List<User> getUsers(long pk, int start, int end, OrderByComparator orderByComparator)
          Gets an ordered range of all the users associated with the user group.
 int getUsersSize(long pk)
          Gets the number of users associated with the user group.
 UserGroup remove(long userGroupId)
          Removes the user group with the primary key from the database.
 void removeAll()
          Removes all the user groups from the database.
 void removeByC_N(long companyId, String name)
          Removes the user group where companyId = ? and name = ? from the database.
 void removeByC_P(long companyId, long parentUserGroupId)
          Removes all the user groups where companyId = ? and parentUserGroupId = ? from the database.
 void removeByCompanyId(long companyId)
          Removes all the user groups where companyId = ? from the database.
 void removeGroup(long pk, Group group)
          Removes the association between the user group and the group.
 void removeGroup(long pk, long groupPK)
          Removes the association between the user group and the group.
 void removeGroups(long pk, List<Group> groups)
          Removes the association between the user group and the groups.
 void removeGroups(long pk, long[] groupPKs)
          Removes the association between the user group and the groups.
 void removeUser(long pk, long userPK)
          Removes the association between the user group and the user.
 void removeUser(long pk, User user)
          Removes the association between the user group and the user.
 void removeUsers(long pk, List<User> users)
          Removes the association between the user group and the users.
 void removeUsers(long pk, long[] userPKs)
          Removes the association between the user group and the users.
 void setGroups(long pk, List<Group> groups)
          Sets the groups associated with the user group, removing and adding associations as necessary.
 void setGroups(long pk, long[] groupPKs)
          Sets the groups associated with the user group, removing and adding associations as necessary.
 void setUsers(long pk, List<User> users)
          Sets the users associated with the user group, removing and adding associations as necessary.
 void setUsers(long pk, long[] userPKs)
          Sets the users associated with the user group, removing and adding associations as necessary.
 UserGroup updateImpl(UserGroup userGroup, boolean merge)
           
 
Methods inherited from interface com.liferay.portal.service.persistence.BasePersistence
clearCache, clearCache, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, registerListener, remove, remove, setDataSource, unregisterListener, update, update
 

Method Detail

cacheResult

void cacheResult(UserGroup userGroup)
Caches the user group in the entity cache if it is enabled.

Parameters:
userGroup - the user group to cache

cacheResult

void cacheResult(List<UserGroup> userGroups)
Caches the user groups in the entity cache if it is enabled.

Parameters:
userGroups - the user groups to cache

create

UserGroup create(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

remove

UserGroup remove(long userGroupId)
                 throws NoSuchUserGroupException,
                        SystemException
Removes 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 to remove
Returns:
the user group that was removed
Throws:
NoSuchUserGroupException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

updateImpl

UserGroup updateImpl(UserGroup userGroup,
                     boolean merge)
                     throws SystemException
Throws:
SystemException

findByPrimaryKey

UserGroup findByPrimaryKey(long userGroupId)
                           throws NoSuchUserGroupException,
                                  SystemException
Finds the user group with the primary key or throws a NoSuchUserGroupException if it could not be found.

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

fetchByPrimaryKey

UserGroup fetchByPrimaryKey(long userGroupId)
                            throws SystemException
Finds the user group with the primary key or returns null if it could not be found.

Parameters:
userGroupId - the primary key of the user group to find
Returns:
the user group, or null if a user group with the primary key could not be found
Throws:
SystemException - if a system exception occurred

findByCompanyId

List<UserGroup> findByCompanyId(long companyId)
                                throws SystemException
Finds all the user groups where companyId = ?.

Parameters:
companyId - the company id to search with
Returns:
the matching user groups
Throws:
SystemException - if a system exception occurred

findByCompanyId

List<UserGroup> findByCompanyId(long companyId,
                                int start,
                                int end)
                                throws SystemException
Finds a range of all the user groups where companyId = ?.

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 company id to search with
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)
Returns:
the range of matching user groups
Throws:
SystemException - if a system exception occurred

findByCompanyId

List<UserGroup> findByCompanyId(long companyId,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                                throws SystemException
Finds an ordered range of all the user groups where companyId = ?.

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 company id to search with
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)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching user groups
Throws:
SystemException - if a system exception occurred

findByCompanyId_First

UserGroup findByCompanyId_First(long companyId,
                                OrderByComparator orderByComparator)
                                throws NoSuchUserGroupException,
                                       SystemException
Finds the first user group in the ordered set where companyId = ?.

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 company id to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching user group
Throws:
NoSuchUserGroupException - if a matching user group could not be found
SystemException - if a system exception occurred

findByCompanyId_Last

UserGroup findByCompanyId_Last(long companyId,
                               OrderByComparator orderByComparator)
                               throws NoSuchUserGroupException,
                                      SystemException
Finds the last user group in the ordered set where companyId = ?.

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 company id to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching user group
Throws:
NoSuchUserGroupException - if a matching user group could not be found
SystemException - if a system exception occurred

findByCompanyId_PrevAndNext

UserGroup[] findByCompanyId_PrevAndNext(long userGroupId,
                                        long companyId,
                                        OrderByComparator orderByComparator)
                                        throws NoSuchUserGroupException,
                                               SystemException
Finds the user groups before and after the current user group in the ordered set where companyId = ?.

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:
userGroupId - the primary key of the current user group
companyId - the company id to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next user group
Throws:
NoSuchUserGroupException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

findByC_P

List<UserGroup> findByC_P(long companyId,
                          long parentUserGroupId)
                          throws SystemException
Finds all the user groups where companyId = ? and parentUserGroupId = ?.

Parameters:
companyId - the company id to search with
parentUserGroupId - the parent user group id to search with
Returns:
the matching user groups
Throws:
SystemException - if a system exception occurred

findByC_P

List<UserGroup> findByC_P(long companyId,
                          long parentUserGroupId,
                          int start,
                          int end)
                          throws SystemException
Finds a range of all the user groups where companyId = ? and parentUserGroupId = ?.

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 company id to search with
parentUserGroupId - the parent user group id to search with
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)
Returns:
the range of matching user groups
Throws:
SystemException - if a system exception occurred

findByC_P

List<UserGroup> findByC_P(long companyId,
                          long parentUserGroupId,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                          throws SystemException
Finds an ordered range of all the user groups where companyId = ? and parentUserGroupId = ?.

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 company id to search with
parentUserGroupId - the parent user group id to search with
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)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching user groups
Throws:
SystemException - if a system exception occurred

findByC_P_First

UserGroup findByC_P_First(long companyId,
                          long parentUserGroupId,
                          OrderByComparator orderByComparator)
                          throws NoSuchUserGroupException,
                                 SystemException
Finds the first user group in the ordered set where companyId = ? and parentUserGroupId = ?.

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 company id to search with
parentUserGroupId - the parent user group id to search with
orderByComparator - the comparator to order the set by
Returns:
the first matching user group
Throws:
NoSuchUserGroupException - if a matching user group could not be found
SystemException - if a system exception occurred

findByC_P_Last

UserGroup findByC_P_Last(long companyId,
                         long parentUserGroupId,
                         OrderByComparator orderByComparator)
                         throws NoSuchUserGroupException,
                                SystemException
Finds the last user group in the ordered set where companyId = ? and parentUserGroupId = ?.

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 company id to search with
parentUserGroupId - the parent user group id to search with
orderByComparator - the comparator to order the set by
Returns:
the last matching user group
Throws:
NoSuchUserGroupException - if a matching user group could not be found
SystemException - if a system exception occurred

findByC_P_PrevAndNext

UserGroup[] findByC_P_PrevAndNext(long userGroupId,
                                  long companyId,
                                  long parentUserGroupId,
                                  OrderByComparator orderByComparator)
                                  throws NoSuchUserGroupException,
                                         SystemException
Finds the user groups before and after the current user group in the ordered set where companyId = ? and parentUserGroupId = ?.

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:
userGroupId - the primary key of the current user group
companyId - the company id to search with
parentUserGroupId - the parent user group id to search with
orderByComparator - the comparator to order the set by
Returns:
the previous, current, and next user group
Throws:
NoSuchUserGroupException - if a user group with the primary key could not be found
SystemException - if a system exception occurred

findByC_N

UserGroup findByC_N(long companyId,
                    String name)
                    throws NoSuchUserGroupException,
                           SystemException
Finds the user group where companyId = ? and name = ? or throws a NoSuchUserGroupException if it could not be found.

Parameters:
companyId - the company id to search with
name - the name to search with
Returns:
the matching user group
Throws:
NoSuchUserGroupException - if a matching user group could not be found
SystemException - if a system exception occurred

fetchByC_N

UserGroup fetchByC_N(long companyId,
                     String name)
                     throws SystemException
Finds the user group where companyId = ? and name = ? or returns null if it could not be found. Uses the finder cache.

Parameters:
companyId - the company id to search with
name - the name to search with
Returns:
the matching user group, or null if a matching user group could not be found
Throws:
SystemException - if a system exception occurred

fetchByC_N

UserGroup fetchByC_N(long companyId,
                     String name,
                     boolean retrieveFromCache)
                     throws SystemException
Finds the user group where companyId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:
companyId - the company id to search with
name - the name to search with
Returns:
the matching user group, or null if a matching user group could not be found
Throws:
SystemException - if a system exception occurred

findAll

List<UserGroup> findAll()
                        throws SystemException
Finds all the user groups.

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

findAll

List<UserGroup> findAll(int start,
                        int end)
                        throws SystemException
Finds 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 to return
end - the upper bound of the range of user groups to return (not inclusive)
Returns:
the range of user groups
Throws:
SystemException - if a system exception occurred

findAll

List<UserGroup> findAll(int start,
                        int end,
                        OrderByComparator orderByComparator)
                        throws SystemException
Finds an ordered 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 to return
end - the upper bound of the range of user groups to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of user groups
Throws:
SystemException - if a system exception occurred

removeByCompanyId

void removeByCompanyId(long companyId)
                       throws SystemException
Removes all the user groups where companyId = ? from the database.

Parameters:
companyId - the company id to search with
Throws:
SystemException - if a system exception occurred

removeByC_P

void removeByC_P(long companyId,
                 long parentUserGroupId)
                 throws SystemException
Removes all the user groups where companyId = ? and parentUserGroupId = ? from the database.

Parameters:
companyId - the company id to search with
parentUserGroupId - the parent user group id to search with
Throws:
SystemException - if a system exception occurred

removeByC_N

void removeByC_N(long companyId,
                 String name)
                 throws NoSuchUserGroupException,
                        SystemException
Removes the user group where companyId = ? and name = ? from the database.

Parameters:
companyId - the company id to search with
name - the name to search with
Throws:
SystemException - if a system exception occurred
NoSuchUserGroupException

removeAll

void removeAll()
               throws SystemException
Removes all the user groups from the database.

Throws:
SystemException - if a system exception occurred

countByCompanyId

int countByCompanyId(long companyId)
                     throws SystemException
Counts all the user groups where companyId = ?.

Parameters:
companyId - the company id to search with
Returns:
the number of matching user groups
Throws:
SystemException - if a system exception occurred

countByC_P

int countByC_P(long companyId,
               long parentUserGroupId)
               throws SystemException
Counts all the user groups where companyId = ? and parentUserGroupId = ?.

Parameters:
companyId - the company id to search with
parentUserGroupId - the parent user group id to search with
Returns:
the number of matching user groups
Throws:
SystemException - if a system exception occurred

countByC_N

int countByC_N(long companyId,
               String name)
               throws SystemException
Counts all the user groups where companyId = ? and name = ?.

Parameters:
companyId - the company id to search with
name - the name to search with
Returns:
the number of matching user groups
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Counts all the user groups.

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

getGroups

List<Group> getGroups(long pk)
                      throws SystemException
Gets all the groups associated with the user group.

Parameters:
pk - the primary key of the user group to get the associated groups for
Returns:
the groups associated with the user group
Throws:
SystemException - if a system exception occurred

getGroups

List<Group> getGroups(long pk,
                      int start,
                      int end)
                      throws SystemException
Gets a range of all the groups associated with the user group.

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:
pk - the primary key of the user group to get the associated groups for
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)
Returns:
the range of groups associated with the user group
Throws:
SystemException - if a system exception occurred

getGroups

List<Group> getGroups(long pk,
                      int start,
                      int end,
                      OrderByComparator orderByComparator)
                      throws SystemException
Gets an ordered range of all the groups associated with the user group.

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:
pk - the primary key of the user group to get the associated groups for
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)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of groups associated with the user group
Throws:
SystemException - if a system exception occurred

getGroupsSize

int getGroupsSize(long pk)
                  throws SystemException
Gets the number of groups associated with the user group.

Parameters:
pk - the primary key of the user group to get the number of associated groups for
Returns:
the number of groups associated with the user group
Throws:
SystemException - if a system exception occurred

containsGroup

boolean containsGroup(long pk,
                      long groupPK)
                      throws SystemException
Determines whether the group is associated with the user group.

Parameters:
pk - the primary key of the user group
groupPK - the primary key of the group
Returns:
whether the group is associated with the user group
Throws:
SystemException - if a system exception occurred

containsGroups

boolean containsGroups(long pk)
                       throws SystemException
Determines whether the user group has any groups associated with it.

Parameters:
pk - the primary key of the user group to check for associations with groups
Returns:
whether the user group has any groups associated with it
Throws:
SystemException - if a system exception occurred

addGroup

void addGroup(long pk,
              long groupPK)
              throws SystemException
Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group
groupPK - the primary key of the group
Throws:
SystemException - if a system exception occurred

addGroup

void addGroup(long pk,
              Group group)
              throws SystemException
Adds an association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

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

addGroups

void addGroups(long pk,
               long[] groupPKs)
               throws SystemException
Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

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

addGroups

void addGroups(long pk,
               List<Group> groups)
               throws SystemException
Adds an association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

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

clearGroups

void clearGroups(long pk)
                 throws SystemException
Clears all associations between the user group and its groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group to clear the associated groups from
Throws:
SystemException - if a system exception occurred

removeGroup

void removeGroup(long pk,
                 long groupPK)
                 throws SystemException
Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group
groupPK - the primary key of the group
Throws:
SystemException - if a system exception occurred

removeGroup

void removeGroup(long pk,
                 Group group)
                 throws SystemException
Removes the association between the user group and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

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

removeGroups

void removeGroups(long pk,
                  long[] groupPKs)
                  throws SystemException
Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

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

removeGroups

void removeGroups(long pk,
                  List<Group> groups)
                  throws SystemException
Removes the association between the user group and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

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

setGroups

void setGroups(long pk,
               long[] groupPKs)
               throws SystemException
Sets the groups associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group to set the associations for
groupPKs - the primary keys of the groups to be associated with the user group
Throws:
SystemException - if a system exception occurred

setGroups

void setGroups(long pk,
               List<Group> groups)
               throws SystemException
Sets the groups associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group to set the associations for
groups - the groups to be associated with the user group
Throws:
SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk)
                    throws SystemException
Gets all the users associated with the user group.

Parameters:
pk - the primary key of the user group to get the associated users for
Returns:
the users associated with the user group
Throws:
SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk,
                    int start,
                    int end)
                    throws SystemException
Gets a range of all the users associated with the user group.

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:
pk - the primary key of the user group to get the associated users for
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)
Returns:
the range of users associated with the user group
Throws:
SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk,
                    int start,
                    int end,
                    OrderByComparator orderByComparator)
                    throws SystemException
Gets an ordered range of all the users associated with the user group.

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:
pk - the primary key of the user group to get the associated users for
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)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of users associated with the user group
Throws:
SystemException - if a system exception occurred

getUsersSize

int getUsersSize(long pk)
                 throws SystemException
Gets the number of users associated with the user group.

Parameters:
pk - the primary key of the user group to get the number of associated users for
Returns:
the number of users associated with the user group
Throws:
SystemException - if a system exception occurred

containsUser

boolean containsUser(long pk,
                     long userPK)
                     throws SystemException
Determines whether the user is associated with the user group.

Parameters:
pk - the primary key of the user group
userPK - the primary key of the user
Returns:
whether the user is associated with the user group
Throws:
SystemException - if a system exception occurred

containsUsers

boolean containsUsers(long pk)
                      throws SystemException
Determines whether the user group has any users associated with it.

Parameters:
pk - the primary key of the user group to check for associations with users
Returns:
whether the user group has any users associated with it
Throws:
SystemException - if a system exception occurred

addUser

void addUser(long pk,
             long userPK)
             throws SystemException
Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group
userPK - the primary key of the user
Throws:
SystemException - if a system exception occurred

addUser

void addUser(long pk,
             User user)
             throws SystemException
Adds an association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

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

addUsers

void addUsers(long pk,
              long[] userPKs)
              throws SystemException
Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group
userPKs - the primary keys of the users
Throws:
SystemException - if a system exception occurred

addUsers

void addUsers(long pk,
              List<User> users)
              throws SystemException
Adds an association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group
users - the users
Throws:
SystemException - if a system exception occurred

clearUsers

void clearUsers(long pk)
                throws SystemException
Clears all associations between the user group and its users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group to clear the associated users from
Throws:
SystemException - if a system exception occurred

removeUser

void removeUser(long pk,
                long userPK)
                throws SystemException
Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group
userPK - the primary key of the user
Throws:
SystemException - if a system exception occurred

removeUser

void removeUser(long pk,
                User user)
                throws SystemException
Removes the association between the user group and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

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

removeUsers

void removeUsers(long pk,
                 long[] userPKs)
                 throws SystemException
Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group
userPKs - the primary keys of the users
Throws:
SystemException - if a system exception occurred

removeUsers

void removeUsers(long pk,
                 List<User> users)
                 throws SystemException
Removes the association between the user group and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group
users - the users
Throws:
SystemException - if a system exception occurred

setUsers

void setUsers(long pk,
              long[] userPKs)
              throws SystemException
Sets the users associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group to set the associations for
userPKs - the primary keys of the users to be associated with the user group
Throws:
SystemException - if a system exception occurred

setUsers

void setUsers(long pk,
              List<User> users)
              throws SystemException
Sets the users associated with the user group, removing and adding associations as necessary. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:
pk - the primary key of the user group to set the associations for
users - the users to be associated with the user group
Throws:
SystemException - if a system exception occurred

Liferay 6.0.5