com.liferay.portal.service.persistence
Interface UserGroupPersistence

All Superinterfaces:

BasePersistence<UserGroup>

public interface UserGroupPersistence
extends BasePersistence<UserGroup>

The persistence interface for the user group service.

Caching information and settings can be found in portal.properties

See Also:

UserGroupPersistenceImpl, UserGroupUtil

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	addTeam(long pk, long teamPK) Adds an association between the user group and the team.
void	addTeam(long pk, Team team) Adds an association between the user group and the team.
void	addTeams(long pk, List<Team> teams) Adds an association between the user group and the teams.
void	addTeams(long pk, long[] teamPKs) Adds an association between the user group and the teams.
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	clearTeams(long pk) Clears all associations between the user group and its teams.
void	clearUsers(long pk) Clears all associations between the user group and its users.
boolean	containsGroup(long pk, long groupPK) Returns true if the group is associated with the user group.
boolean	containsGroups(long pk) Returns true if the user group has any groups associated with it.
boolean	containsTeam(long pk, long teamPK) Returns true if the team is associated with the user group.
boolean	containsTeams(long pk) Returns true if the user group has any teams associated with it.
boolean	containsUser(long pk, long userPK) Returns true if the user is associated with the user group.
boolean	containsUsers(long pk) Returns true if the user group has any users associated with it.
int	countAll() Returns the number of user groups.
int	countByC_N(long companyId, String name) Returns the number of user groups where companyId = ? and name = ?.
int	countByC_P(long companyId, long parentUserGroupId) Returns the number of user groups where companyId = ? and parentUserGroupId = ?.
int	countByCompanyId(long companyId) Returns the number of user groups where companyId = ?.
UserGroup	create(long userGroupId) Creates a new user group with the primary key.
UserGroup	fetchByC_N(long companyId, String name) Returns 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) Returns the user group where companyId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
UserGroup	fetchByC_P_First(long companyId, long parentUserGroupId, OrderByComparator orderByComparator) Returns the first user group in the ordered set where companyId = ? and parentUserGroupId = ?.
UserGroup	fetchByC_P_Last(long companyId, long parentUserGroupId, OrderByComparator orderByComparator) Returns the last user group in the ordered set where companyId = ? and parentUserGroupId = ?.
UserGroup	fetchByCompanyId_First(long companyId, OrderByComparator orderByComparator) Returns the first user group in the ordered set where companyId = ?.
UserGroup	fetchByCompanyId_Last(long companyId, OrderByComparator orderByComparator) Returns the last user group in the ordered set where companyId = ?.
UserGroup	fetchByPrimaryKey(long userGroupId) Returns the user group with the primary key or returns null if it could not be found.
int	filterCountByC_P(long companyId, long parentUserGroupId) Returns the number of user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?.
int	filterCountByCompanyId(long companyId) Returns the number of user groups that the user has permission to view where companyId = ?.
UserGroup[]	filterFindByC_P_PrevAndNext(long userGroupId, long companyId, long parentUserGroupId, OrderByComparator orderByComparator) Returns the user groups before and after the current user group in the ordered set of user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?.
List<UserGroup>	filterFindByC_P(long companyId, long parentUserGroupId) Returns all the user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?.
List<UserGroup>	filterFindByC_P(long companyId, long parentUserGroupId, int start, int end) Returns a range of all the user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?.
List<UserGroup>	filterFindByC_P(long companyId, long parentUserGroupId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the user groups that the user has permissions to view where companyId = ? and parentUserGroupId = ?.
UserGroup[]	filterFindByCompanyId_PrevAndNext(long userGroupId, long companyId, OrderByComparator orderByComparator) Returns the user groups before and after the current user group in the ordered set of user groups that the user has permission to view where companyId = ?.
List<UserGroup>	filterFindByCompanyId(long companyId) Returns all the user groups that the user has permission to view where companyId = ?.
List<UserGroup>	filterFindByCompanyId(long companyId, int start, int end) Returns a range of all the user groups that the user has permission to view where companyId = ?.
List<UserGroup>	filterFindByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the user groups that the user has permissions to view where companyId = ?.
List<UserGroup>	findAll() Returns all the user groups.
List<UserGroup>	findAll(int start, int end) Returns a range of all the user groups.
List<UserGroup>	findAll(int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the user groups.
UserGroup	findByC_N(long companyId, String name) Returns 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) Returns the first user group in the ordered set where companyId = ? and parentUserGroupId = ?.
UserGroup	findByC_P_Last(long companyId, long parentUserGroupId, OrderByComparator orderByComparator) Returns the last user group in the ordered set where companyId = ? and parentUserGroupId = ?.
UserGroup[]	findByC_P_PrevAndNext(long userGroupId, long companyId, long parentUserGroupId, OrderByComparator orderByComparator) Returns 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) Returns all the user groups where companyId = ? and parentUserGroupId = ?.
List<UserGroup>	findByC_P(long companyId, long parentUserGroupId, int start, int end) Returns 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) Returns an ordered range of all the user groups where companyId = ? and parentUserGroupId = ?.
UserGroup	findByCompanyId_First(long companyId, OrderByComparator orderByComparator) Returns the first user group in the ordered set where companyId = ?.
UserGroup	findByCompanyId_Last(long companyId, OrderByComparator orderByComparator) Returns the last user group in the ordered set where companyId = ?.
UserGroup[]	findByCompanyId_PrevAndNext(long userGroupId, long companyId, OrderByComparator orderByComparator) Returns the user groups before and after the current user group in the ordered set where companyId = ?.
List<UserGroup>	findByCompanyId(long companyId) Returns all the user groups where companyId = ?.
List<UserGroup>	findByCompanyId(long companyId, int start, int end) Returns a range of all the user groups where companyId = ?.
List<UserGroup>	findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the user groups where companyId = ?.
UserGroup	findByPrimaryKey(long userGroupId) Returns the user group with the primary key or throws a NoSuchUserGroupException if it could not be found.
List<Group>	getGroups(long pk) Returns all the groups associated with the user group.
List<Group>	getGroups(long pk, int start, int end) Returns a range of all the groups associated with the user group.
List<Group>	getGroups(long pk, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the groups associated with the user group.
int	getGroupsSize(long pk) Returns the number of groups associated with the user group.
List<Team>	getTeams(long pk) Returns all the teams associated with the user group.
List<Team>	getTeams(long pk, int start, int end) Returns a range of all the teams associated with the user group.
List<Team>	getTeams(long pk, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the teams associated with the user group.
int	getTeamsSize(long pk) Returns the number of teams associated with the user group.
List<User>	getUsers(long pk) Returns all the users associated with the user group.
List<User>	getUsers(long pk, int start, int end) Returns a range of all the users associated with the user group.
List<User>	getUsers(long pk, int start, int end, OrderByComparator orderByComparator) Returns an ordered range of all the users associated with the user group.
int	getUsersSize(long pk) Returns 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.
UserGroup	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	removeTeam(long pk, long teamPK) Removes the association between the user group and the team.
void	removeTeam(long pk, Team team) Removes the association between the user group and the team.
void	removeTeams(long pk, List<Team> teams) Removes the association between the user group and the teams.
void	removeTeams(long pk, long[] teamPKs) Removes the association between the user group and the teams.
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	setTeams(long pk, List<Team> teams) Sets the teams associated with the user group, removing and adding associations as necessary.
void	setTeams(long pk, long[] teamPKs) Sets the teams 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, clearCache, closeSession, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, openSession, processException, 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

cacheResult

void cacheResult(List<UserGroup> userGroups)

Caches the user groups in the entity cache if it is enabled.

Parameters:

userGroups - the user groups

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

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

Returns 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

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

Returns 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

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

Returns all the user groups where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the matching user groups

Throws:

SystemException - if a system exception occurred

findByCompanyId

List<UserGroup> findByCompanyId(long companyId,
                                int start,
                                int end)
                                throws SystemException

Returns 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

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 matching user groups

Throws:

SystemException - if a system exception occurred

findByCompanyId

List<UserGroup> findByCompanyId(long companyId,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                                throws SystemException

Returns 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

start - the lower bound of the range of user groups

end - the upper bound of the range of user groups (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

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

Returns the first user group in the ordered set where companyId = ?.

Parameters:

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching user group

Throws:

NoSuchUserGroupException - if a matching user group could not be found

SystemException - if a system exception occurred

fetchByCompanyId_First

UserGroup fetchByCompanyId_First(long companyId,
                                 OrderByComparator orderByComparator)
                                 throws SystemException

Returns the first user group in the ordered set where companyId = ?.

Parameters:

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching user group, or null if a matching user group could not be found

Throws:

SystemException - if a system exception occurred

findByCompanyId_Last

UserGroup findByCompanyId_Last(long companyId,
                               OrderByComparator orderByComparator)
                               throws NoSuchUserGroupException,
                                      SystemException

Returns the last user group in the ordered set where companyId = ?.

Parameters:

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching user group

Throws:

NoSuchUserGroupException - if a matching user group could not be found

SystemException - if a system exception occurred

fetchByCompanyId_Last

UserGroup fetchByCompanyId_Last(long companyId,
                                OrderByComparator orderByComparator)
                                throws SystemException

Returns the last user group in the ordered set where companyId = ?.

Parameters:

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching user group, or null if a matching user group could not be found

Throws:

SystemException - if a system exception occurred

findByCompanyId_PrevAndNext

UserGroup[] findByCompanyId_PrevAndNext(long userGroupId,
                                        long companyId,
                                        OrderByComparator orderByComparator)
                                        throws NoSuchUserGroupException,
                                               SystemException

Returns the user groups before and after the current user group in the ordered set where companyId = ?.

Parameters:

userGroupId - the primary key of the current user group

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

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

filterFindByCompanyId

List<UserGroup> filterFindByCompanyId(long companyId)
                                      throws SystemException

Returns all the user groups that the user has permission to view where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the matching user groups that the user has permission to view

Throws:

SystemException - if a system exception occurred

filterFindByCompanyId

List<UserGroup> filterFindByCompanyId(long companyId,
                                      int start,
                                      int end)
                                      throws SystemException

Returns a range of all the user groups that the user has permission to view 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

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 matching user groups that the user has permission to view

Throws:

SystemException - if a system exception occurred

filterFindByCompanyId

List<UserGroup> filterFindByCompanyId(long companyId,
                                      int start,
                                      int end,
                                      OrderByComparator orderByComparator)
                                      throws SystemException

Returns an ordered range of all the user groups that the user has permissions to view 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

start - the lower bound of the range of user groups

end - the upper bound of the range of user groups (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching user groups that the user has permission to view

Throws:

SystemException - if a system exception occurred

filterFindByCompanyId_PrevAndNext

UserGroup[] filterFindByCompanyId_PrevAndNext(long userGroupId,
                                              long companyId,
                                              OrderByComparator orderByComparator)
                                              throws NoSuchUserGroupException,
                                                     SystemException

Returns the user groups before and after the current user group in the ordered set of user groups that the user has permission to view where companyId = ?.

Parameters:

userGroupId - the primary key of the current user group

companyId - the company ID

orderByComparator - the comparator to order the set by (optionally null)

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

Returns all the user groups where companyId = ? and parentUserGroupId = ?.

Parameters:

companyId - the company ID

parentUserGroupId - the parent user group ID

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

Returns 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

parentUserGroupId - the parent user group ID

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 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

Returns 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

parentUserGroupId - the parent user group ID

start - the lower bound of the range of user groups

end - the upper bound of the range of user groups (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

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

Returns the first user group in the ordered set where companyId = ? and parentUserGroupId = ?.

Parameters:

companyId - the company ID

parentUserGroupId - the parent user group ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching user group

Throws:

NoSuchUserGroupException - if a matching user group could not be found

SystemException - if a system exception occurred

fetchByC_P_First

UserGroup fetchByC_P_First(long companyId,
                           long parentUserGroupId,
                           OrderByComparator orderByComparator)
                           throws SystemException

Returns the first user group in the ordered set where companyId = ? and parentUserGroupId = ?.

Parameters:

companyId - the company ID

parentUserGroupId - the parent user group ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the first matching user group, or null if a matching user group could not be found

Throws:

SystemException - if a system exception occurred

findByC_P_Last

UserGroup findByC_P_Last(long companyId,
                         long parentUserGroupId,
                         OrderByComparator orderByComparator)
                         throws NoSuchUserGroupException,
                                SystemException

Returns the last user group in the ordered set where companyId = ? and parentUserGroupId = ?.

Parameters:

companyId - the company ID

parentUserGroupId - the parent user group ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching user group

Throws:

NoSuchUserGroupException - if a matching user group could not be found

SystemException - if a system exception occurred

fetchByC_P_Last

UserGroup fetchByC_P_Last(long companyId,
                          long parentUserGroupId,
                          OrderByComparator orderByComparator)
                          throws SystemException

Returns the last user group in the ordered set where companyId = ? and parentUserGroupId = ?.

Parameters:

companyId - the company ID

parentUserGroupId - the parent user group ID

orderByComparator - the comparator to order the set by (optionally null)

Returns:

the last matching user group, or null if a matching user group could not be found

Throws:

SystemException - if a system exception occurred

findByC_P_PrevAndNext

UserGroup[] findByC_P_PrevAndNext(long userGroupId,
                                  long companyId,
                                  long parentUserGroupId,
                                  OrderByComparator orderByComparator)
                                  throws NoSuchUserGroupException,
                                         SystemException

Returns the user groups before and after the current user group in the ordered set where companyId = ? and parentUserGroupId = ?.

Parameters:

userGroupId - the primary key of the current user group

companyId - the company ID

parentUserGroupId - the parent user group ID

orderByComparator - the comparator to order the set by (optionally null)

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

filterFindByC_P

List<UserGroup> filterFindByC_P(long companyId,
                                long parentUserGroupId)
                                throws SystemException

Returns all the user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?.

Parameters:

companyId - the company ID

parentUserGroupId - the parent user group ID

Returns:

the matching user groups that the user has permission to view

Throws:

SystemException - if a system exception occurred

filterFindByC_P

List<UserGroup> filterFindByC_P(long companyId,
                                long parentUserGroupId,
                                int start,
                                int end)
                                throws SystemException

Returns a range of all the user groups that the user has permission to view 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

parentUserGroupId - the parent user group ID

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 matching user groups that the user has permission to view

Throws:

SystemException - if a system exception occurred

filterFindByC_P

List<UserGroup> filterFindByC_P(long companyId,
                                long parentUserGroupId,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                                throws SystemException

Returns an ordered range of all the user groups that the user has permissions to view 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

parentUserGroupId - the parent user group ID

start - the lower bound of the range of user groups

end - the upper bound of the range of user groups (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching user groups that the user has permission to view

Throws:

SystemException - if a system exception occurred

filterFindByC_P_PrevAndNext

UserGroup[] filterFindByC_P_PrevAndNext(long userGroupId,
                                        long companyId,
                                        long parentUserGroupId,
                                        OrderByComparator orderByComparator)
                                        throws NoSuchUserGroupException,
                                               SystemException

Returns the user groups before and after the current user group in the ordered set of user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?.

Parameters:

userGroupId - the primary key of the current user group

companyId - the company ID

parentUserGroupId - the parent user group ID

orderByComparator - the comparator to order the set by (optionally null)

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

Returns the user group where companyId = ? and name = ? or throws a NoSuchUserGroupException if it could not be found.

Parameters:

companyId - the company ID

name - the name

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

Returns 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

name - the name

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

Returns 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

name - the name

retrieveFromCache - whether to use the finder cache

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

Returns 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

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

findAll

List<UserGroup> findAll(int start,
                        int end,
                        OrderByComparator orderByComparator)
                        throws SystemException

Returns 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

end - the upper bound of the range of user groups (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

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

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

parentUserGroupId - the parent user group ID

Throws:

SystemException - if a system exception occurred

removeByC_N

UserGroup 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

name - the name

Returns:

the user group that was removed

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

Returns the number of user groups where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the number of matching user groups

Throws:

SystemException - if a system exception occurred

filterCountByCompanyId

int filterCountByCompanyId(long companyId)
                           throws SystemException

Returns the number of user groups that the user has permission to view where companyId = ?.

Parameters:

companyId - the company ID

Returns:

the number of matching user groups that the user has permission to view

Throws:

SystemException - if a system exception occurred

countByC_P

int countByC_P(long companyId,
               long parentUserGroupId)
               throws SystemException

Returns the number of user groups where companyId = ? and parentUserGroupId = ?.

Parameters:

companyId - the company ID

parentUserGroupId - the parent user group ID

Returns:

the number of matching user groups

Throws:

SystemException - if a system exception occurred

filterCountByC_P

int filterCountByC_P(long companyId,
                     long parentUserGroupId)
                     throws SystemException

Returns the number of user groups that the user has permission to view where companyId = ? and parentUserGroupId = ?.

Parameters:

companyId - the company ID

parentUserGroupId - the parent user group ID

Returns:

the number of matching user groups that the user has permission to view

Throws:

SystemException - if a system exception occurred

countByC_N

int countByC_N(long companyId,
               String name)
               throws SystemException

Returns the number of user groups where companyId = ? and name = ?.

Parameters:

companyId - the company ID

name - the name

Returns:

the number of matching user groups

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Returns the number of user groups.

Returns:

the number of user groups

Throws:

SystemException - if a system exception occurred

getGroups

List<Group> getGroups(long pk)
                      throws SystemException

Returns all the groups associated with the user group.

Parameters:

pk - the primary key of the user group

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

Returns 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

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 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

Returns 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

start - the lower bound of the range of user groups

end - the upper bound of the range of user groups (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

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

Returns the number of groups associated with the user group.

Parameters:

pk - the primary key of the user group

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

Returns true if 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:

true if the group is associated with the user group; false otherwise

Throws:

SystemException - if a system exception occurred

containsGroups

boolean containsGroups(long pk)
                       throws SystemException

Returns true if 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:

true if the user group has any groups associated with it; false otherwise

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

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

groups - the groups to be associated with the user group

Throws:

SystemException - if a system exception occurred

getTeams

List<Team> getTeams(long pk)
                    throws SystemException

Returns all the teams associated with the user group.

Parameters:

pk - the primary key of the user group

Returns:

the teams associated with the user group

Throws:

SystemException - if a system exception occurred

getTeams

List<Team> getTeams(long pk,
                    int start,
                    int end)
                    throws SystemException

Returns a range of all the teams 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

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 teams associated with the user group

Throws:

SystemException - if a system exception occurred

getTeams

List<Team> getTeams(long pk,
                    int start,
                    int end,
                    OrderByComparator orderByComparator)
                    throws SystemException

Returns an ordered range of all the teams 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

start - the lower bound of the range of user groups

end - the upper bound of the range of user groups (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of teams associated with the user group

Throws:

SystemException - if a system exception occurred

getTeamsSize

int getTeamsSize(long pk)
                 throws SystemException

Returns the number of teams associated with the user group.

Parameters:

pk - the primary key of the user group

Returns:

the number of teams associated with the user group

Throws:

SystemException - if a system exception occurred

containsTeam

boolean containsTeam(long pk,
                     long teamPK)
                     throws SystemException

Returns true if the team is associated with the user group.

Parameters:

pk - the primary key of the user group

teamPK - the primary key of the team

Returns:

true if the team is associated with the user group; false otherwise

Throws:

SystemException - if a system exception occurred

containsTeams

boolean containsTeams(long pk)
                      throws SystemException

Returns true if the user group has any teams associated with it.

Parameters:

pk - the primary key of the user group to check for associations with teams

Returns:

true if the user group has any teams associated with it; false otherwise

Throws:

SystemException - if a system exception occurred

addTeam

void addTeam(long pk,
             long teamPK)
             throws SystemException

Adds an association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the user group

teamPK - the primary key of the team

Throws:

SystemException - if a system exception occurred

addTeam

void addTeam(long pk,
             Team team)
             throws SystemException

Adds an association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the user group

team - the team

Throws:

SystemException - if a system exception occurred

addTeams

void addTeams(long pk,
              long[] teamPKs)
              throws SystemException

Adds an association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the user group

teamPKs - the primary keys of the teams

Throws:

SystemException - if a system exception occurred

addTeams

void addTeams(long pk,
              List<Team> teams)
              throws SystemException

Adds an association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the user group

teams - the teams

Throws:

SystemException - if a system exception occurred

clearTeams

void clearTeams(long pk)
                throws SystemException

Clears all associations between the user group and its teams. 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 teams from

Throws:

SystemException - if a system exception occurred

removeTeam

void removeTeam(long pk,
                long teamPK)
                throws SystemException

Removes the association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the user group

teamPK - the primary key of the team

Throws:

SystemException - if a system exception occurred

removeTeam

void removeTeam(long pk,
                Team team)
                throws SystemException

Removes the association between the user group and the team. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the user group

team - the team

Throws:

SystemException - if a system exception occurred

removeTeams

void removeTeams(long pk,
                 long[] teamPKs)
                 throws SystemException

Removes the association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the user group

teamPKs - the primary keys of the teams

Throws:

SystemException - if a system exception occurred

removeTeams

void removeTeams(long pk,
                 List<Team> teams)
                 throws SystemException

Removes the association between the user group and the teams. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the user group

teams - the teams

Throws:

SystemException - if a system exception occurred

setTeams

void setTeams(long pk,
              long[] teamPKs)
              throws SystemException

Sets the teams 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

teamPKs - the primary keys of the teams to be associated with the user group

Throws:

SystemException - if a system exception occurred

setTeams

void setTeams(long pk,
              List<Team> teams)
              throws SystemException

Sets the teams 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

teams - the teams to be associated with the user group

Throws:

SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk)
                    throws SystemException

Returns all the users associated with the user group.

Parameters:

pk - the primary key of the user group

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

Returns 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

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 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

Returns 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

start - the lower bound of the range of user groups

end - the upper bound of the range of user groups (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

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

Returns the number of users associated with the user group.

Parameters:

pk - the primary key of the user group

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

Returns true if 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:

true if the user is associated with the user group; false otherwise

Throws:

SystemException - if a system exception occurred

containsUsers

boolean containsUsers(long pk)
                      throws SystemException

Returns true if 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:

true if the user group has any users associated with it; false otherwise

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

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

users - the users to be associated with the user group

Throws:

SystemException - if a system exception occurred