com.liferay.portal.service.persistence
Interface RolePersistence

All Superinterfaces:

BasePersistence<Role>

All Known Implementing Classes:

RolePersistenceImpl

public interface RolePersistence
extends BasePersistence<Role>

The persistence interface for the role service.

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

Caching information and settings can be found in portal.properties

See Also:

RolePersistenceImpl, RoleUtil

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 role and the group.
void	addGroup(long pk, long groupPK) Adds an association between the role and the group.
void	addGroups(long pk, List<Group> groups) Adds an association between the role and the groups.
void	addGroups(long pk, long[] groupPKs) Adds an association between the role and the groups.
void	addPermission(long pk, long permissionPK) Adds an association between the role and the permission.
void	addPermission(long pk, Permission permission) Adds an association between the role and the permission.
void	addPermissions(long pk, List<Permission> permissions) Adds an association between the role and the permissions.
void	addPermissions(long pk, long[] permissionPKs) Adds an association between the role and the permissions.
void	addUser(long pk, long userPK) Adds an association between the role and the user.
void	addUser(long pk, User user) Adds an association between the role and the user.
void	addUsers(long pk, List<User> users) Adds an association between the role and the users.
void	addUsers(long pk, long[] userPKs) Adds an association between the role and the users.
void	cacheResult(List<Role> roles) Caches the roles in the entity cache if it is enabled.
void	cacheResult(Role role) Caches the role in the entity cache if it is enabled.
void	clearGroups(long pk) Clears all associations between the role and its groups.
void	clearPermissions(long pk) Clears all associations between the role and its permissions.
void	clearUsers(long pk) Clears all associations between the role and its users.
boolean	containsGroup(long pk, long groupPK) Determines whether the group is associated with the role.
boolean	containsGroups(long pk) Determines whether the role has any groups associated with it.
boolean	containsPermission(long pk, long permissionPK) Determines whether the permission is associated with the role.
boolean	containsPermissions(long pk) Determines whether the role has any permissions associated with it.
boolean	containsUser(long pk, long userPK) Determines whether the user is associated with the role.
boolean	containsUsers(long pk) Determines whether the role has any users associated with it.
int	countAll() Counts all the roles.
int	countByC_C_C(long companyId, long classNameId, long classPK) Counts all the roles where companyId = ? and classNameId = ? and classPK = ?.
int	countByC_N(long companyId, String name) Counts all the roles where companyId = ? and name = ?.
int	countByCompanyId(long companyId) Counts all the roles where companyId = ?.
int	countBySubtype(String subtype) Counts all the roles where subtype = ?.
int	countByT_S(int type, String subtype) Counts all the roles where type = ? and subtype = ?.
Role	create(long roleId) Creates a new role with the primary key.
Role	fetchByC_C_C(long companyId, long classNameId, long classPK) Finds the role where companyId = ? and classNameId = ? and classPK = ? or returns null if it could not be found.
Role	fetchByC_C_C(long companyId, long classNameId, long classPK, boolean retrieveFromCache) Finds the role where companyId = ? and classNameId = ? and classPK = ? or returns null if it could not be found, optionally using the finder cache.
Role	fetchByC_N(long companyId, String name) Finds the role where companyId = ? and name = ? or returns null if it could not be found.
Role	fetchByC_N(long companyId, String name, boolean retrieveFromCache) Finds the role where companyId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
Role	fetchByPrimaryKey(long roleId) Finds the role with the primary key or returns null if it could not be found.
List<Role>	findAll() Finds all the roles.
List<Role>	findAll(int start, int end) Finds a range of all the roles.
List<Role>	findAll(int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the roles.
Role	findByC_C_C(long companyId, long classNameId, long classPK) Finds the role where companyId = ? and classNameId = ? and classPK = ? or throws a NoSuchRoleException if it could not be found.
Role	findByC_N(long companyId, String name) Finds the role where companyId = ? and name = ? or throws a NoSuchRoleException if it could not be found.
Role	findByCompanyId_First(long companyId, OrderByComparator orderByComparator) Finds the first role in the ordered set where companyId = ?.
Role	findByCompanyId_Last(long companyId, OrderByComparator orderByComparator) Finds the last role in the ordered set where companyId = ?.
Role[]	findByCompanyId_PrevAndNext(long roleId, long companyId, OrderByComparator orderByComparator) Finds the roles before and after the current role in the ordered set where companyId = ?.
List<Role>	findByCompanyId(long companyId) Finds all the roles where companyId = ?.
List<Role>	findByCompanyId(long companyId, int start, int end) Finds a range of all the roles where companyId = ?.
List<Role>	findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the roles where companyId = ?.
Role	findByPrimaryKey(long roleId) Finds the role with the primary key or throws a NoSuchRoleException if it could not be found.
Role	findBySubtype_First(String subtype, OrderByComparator orderByComparator) Finds the first role in the ordered set where subtype = ?.
Role	findBySubtype_Last(String subtype, OrderByComparator orderByComparator) Finds the last role in the ordered set where subtype = ?.
Role[]	findBySubtype_PrevAndNext(long roleId, String subtype, OrderByComparator orderByComparator) Finds the roles before and after the current role in the ordered set where subtype = ?.
List<Role>	findBySubtype(String subtype) Finds all the roles where subtype = ?.
List<Role>	findBySubtype(String subtype, int start, int end) Finds a range of all the roles where subtype = ?.
List<Role>	findBySubtype(String subtype, int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the roles where subtype = ?.
Role	findByT_S_First(int type, String subtype, OrderByComparator orderByComparator) Finds the first role in the ordered set where type = ? and subtype = ?.
Role	findByT_S_Last(int type, String subtype, OrderByComparator orderByComparator) Finds the last role in the ordered set where type = ? and subtype = ?.
Role[]	findByT_S_PrevAndNext(long roleId, int type, String subtype, OrderByComparator orderByComparator) Finds the roles before and after the current role in the ordered set where type = ? and subtype = ?.
List<Role>	findByT_S(int type, String subtype) Finds all the roles where type = ? and subtype = ?.
List<Role>	findByT_S(int type, String subtype, int start, int end) Finds a range of all the roles where type = ? and subtype = ?.
List<Role>	findByT_S(int type, String subtype, int start, int end, OrderByComparator orderByComparator) Finds an ordered range of all the roles where type = ? and subtype = ?.
List<Group>	getGroups(long pk) Gets all the groups associated with the role.
List<Group>	getGroups(long pk, int start, int end) Gets a range of all the groups associated with the role.
List<Group>	getGroups(long pk, int start, int end, OrderByComparator orderByComparator) Gets an ordered range of all the groups associated with the role.
int	getGroupsSize(long pk) Gets the number of groups associated with the role.
List<Permission>	getPermissions(long pk) Gets all the permissions associated with the role.
List<Permission>	getPermissions(long pk, int start, int end) Gets a range of all the permissions associated with the role.
List<Permission>	getPermissions(long pk, int start, int end, OrderByComparator orderByComparator) Gets an ordered range of all the permissions associated with the role.
int	getPermissionsSize(long pk) Gets the number of permissions associated with the role.
List<User>	getUsers(long pk) Gets all the users associated with the role.
List<User>	getUsers(long pk, int start, int end) Gets a range of all the users associated with the role.
List<User>	getUsers(long pk, int start, int end, OrderByComparator orderByComparator) Gets an ordered range of all the users associated with the role.
int	getUsersSize(long pk) Gets the number of users associated with the role.
Role	remove(long roleId) Removes the role with the primary key from the database.
void	removeAll() Removes all the roles from the database.
void	removeByC_C_C(long companyId, long classNameId, long classPK) Removes the role where companyId = ? and classNameId = ? and classPK = ? from the database.
void	removeByC_N(long companyId, String name) Removes the role where companyId = ? and name = ? from the database.
void	removeByCompanyId(long companyId) Removes all the roles where companyId = ? from the database.
void	removeBySubtype(String subtype) Removes all the roles where subtype = ? from the database.
void	removeByT_S(int type, String subtype) Removes all the roles where type = ? and subtype = ? from the database.
void	removeGroup(long pk, Group group) Removes the association between the role and the group.
void	removeGroup(long pk, long groupPK) Removes the association between the role and the group.
void	removeGroups(long pk, List<Group> groups) Removes the association between the role and the groups.
void	removeGroups(long pk, long[] groupPKs) Removes the association between the role and the groups.
void	removePermission(long pk, long permissionPK) Removes the association between the role and the permission.
void	removePermission(long pk, Permission permission) Removes the association between the role and the permission.
void	removePermissions(long pk, List<Permission> permissions) Removes the association between the role and the permissions.
void	removePermissions(long pk, long[] permissionPKs) Removes the association between the role and the permissions.
void	removeUser(long pk, long userPK) Removes the association between the role and the user.
void	removeUser(long pk, User user) Removes the association between the role and the user.
void	removeUsers(long pk, List<User> users) Removes the association between the role and the users.
void	removeUsers(long pk, long[] userPKs) Removes the association between the role and the users.
void	setGroups(long pk, List<Group> groups) Sets the groups associated with the role, removing and adding associations as necessary.
void	setGroups(long pk, long[] groupPKs) Sets the groups associated with the role, removing and adding associations as necessary.
void	setPermissions(long pk, List<Permission> permissions) Sets the permissions associated with the role, removing and adding associations as necessary.
void	setPermissions(long pk, long[] permissionPKs) Sets the permissions associated with the role, removing and adding associations as necessary.
void	setUsers(long pk, List<User> users) Sets the users associated with the role, removing and adding associations as necessary.
void	setUsers(long pk, long[] userPKs) Sets the users associated with the role, removing and adding associations as necessary.
Role	updateImpl(Role role, 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(Role role)

Caches the role in the entity cache if it is enabled.

Parameters:

role - the role to cache

cacheResult

void cacheResult(List<Role> roles)

Caches the roles in the entity cache if it is enabled.

Parameters:

roles - the roles to cache

create

Role create(long roleId)

Creates a new role with the primary key. Does not add the role to the database.

Parameters:

roleId - the primary key for the new role

Returns:

the new role

remove

Role remove(long roleId)
            throws NoSuchRoleException,
                   SystemException

Removes the role with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

roleId - the primary key of the role to remove

Returns:

the role that was removed

Throws:

NoSuchRoleException - if a role with the primary key could not be found

SystemException - if a system exception occurred

updateImpl

Role updateImpl(Role role,
                boolean merge)
                throws SystemException

Throws:

SystemException

findByPrimaryKey

Role findByPrimaryKey(long roleId)
                      throws NoSuchRoleException,
                             SystemException

Finds the role with the primary key or throws a NoSuchRoleException if it could not be found.

Parameters:

roleId - the primary key of the role to find

Returns:

the role

Throws:

NoSuchRoleException - if a role with the primary key could not be found

SystemException - if a system exception occurred

fetchByPrimaryKey

Role fetchByPrimaryKey(long roleId)
                       throws SystemException

Finds the role with the primary key or returns null if it could not be found.

Parameters:

roleId - the primary key of the role to find

Returns:

the role, or null if a role with the primary key could not be found

Throws:

SystemException - if a system exception occurred

findByCompanyId

List<Role> findByCompanyId(long companyId)
                           throws SystemException

Finds all the roles where companyId = ?.

Parameters:

companyId - the company id to search with

Returns:

the matching roles

Throws:

SystemException - if a system exception occurred

findByCompanyId

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

Finds a range of all the roles 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 roles to return

end - the upper bound of the range of roles to return (not inclusive)

Returns:

the range of matching roles

Throws:

SystemException - if a system exception occurred

findByCompanyId

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

Finds an ordered range of all the roles 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 roles to return

end - the upper bound of the range of roles to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching roles

Throws:

SystemException - if a system exception occurred

findByCompanyId_First

Role findByCompanyId_First(long companyId,
                           OrderByComparator orderByComparator)
                           throws NoSuchRoleException,
                                  SystemException

Finds the first role 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 role

Throws:

NoSuchRoleException - if a matching role could not be found

SystemException - if a system exception occurred

findByCompanyId_Last

Role findByCompanyId_Last(long companyId,
                          OrderByComparator orderByComparator)
                          throws NoSuchRoleException,
                                 SystemException

Finds the last role 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 role

Throws:

NoSuchRoleException - if a matching role could not be found

SystemException - if a system exception occurred

findByCompanyId_PrevAndNext

Role[] findByCompanyId_PrevAndNext(long roleId,
                                   long companyId,
                                   OrderByComparator orderByComparator)
                                   throws NoSuchRoleException,
                                          SystemException

Finds the roles before and after the current role 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:

roleId - the primary key of the current role

companyId - the company id to search with

orderByComparator - the comparator to order the set by

Returns:

the previous, current, and next role

Throws:

NoSuchRoleException - if a role with the primary key could not be found

SystemException - if a system exception occurred

findBySubtype

List<Role> findBySubtype(String subtype)
                         throws SystemException

Finds all the roles where subtype = ?.

Parameters:

subtype - the subtype to search with

Returns:

the matching roles

Throws:

SystemException - if a system exception occurred

findBySubtype

List<Role> findBySubtype(String subtype,
                         int start,
                         int end)
                         throws SystemException

Finds a range of all the roles where subtype = ?.

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:

subtype - the subtype to search with

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

Returns:

the range of matching roles

Throws:

SystemException - if a system exception occurred

findBySubtype

List<Role> findBySubtype(String subtype,
                         int start,
                         int end,
                         OrderByComparator orderByComparator)
                         throws SystemException

Finds an ordered range of all the roles where subtype = ?.

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:

subtype - the subtype to search with

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching roles

Throws:

SystemException - if a system exception occurred

findBySubtype_First

Role findBySubtype_First(String subtype,
                         OrderByComparator orderByComparator)
                         throws NoSuchRoleException,
                                SystemException

Finds the first role in the ordered set where subtype = ?.

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:

subtype - the subtype to search with

orderByComparator - the comparator to order the set by

Returns:

the first matching role

Throws:

NoSuchRoleException - if a matching role could not be found

SystemException - if a system exception occurred

findBySubtype_Last

Role findBySubtype_Last(String subtype,
                        OrderByComparator orderByComparator)
                        throws NoSuchRoleException,
                               SystemException

Finds the last role in the ordered set where subtype = ?.

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:

subtype - the subtype to search with

orderByComparator - the comparator to order the set by

Returns:

the last matching role

Throws:

NoSuchRoleException - if a matching role could not be found

SystemException - if a system exception occurred

findBySubtype_PrevAndNext

Role[] findBySubtype_PrevAndNext(long roleId,
                                 String subtype,
                                 OrderByComparator orderByComparator)
                                 throws NoSuchRoleException,
                                        SystemException

Finds the roles before and after the current role in the ordered set where subtype = ?.

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:

roleId - the primary key of the current role

subtype - the subtype to search with

orderByComparator - the comparator to order the set by

Returns:

the previous, current, and next role

Throws:

NoSuchRoleException - if a role with the primary key could not be found

SystemException - if a system exception occurred

findByC_N

Role findByC_N(long companyId,
               String name)
               throws NoSuchRoleException,
                      SystemException

Finds the role where companyId = ? and name = ? or throws a NoSuchRoleException if it could not be found.

Parameters:

companyId - the company id to search with

name - the name to search with

Returns:

the matching role

Throws:

NoSuchRoleException - if a matching role could not be found

SystemException - if a system exception occurred

fetchByC_N

Role fetchByC_N(long companyId,
                String name)
                throws SystemException

Finds the role 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 role, or null if a matching role could not be found

Throws:

SystemException - if a system exception occurred

fetchByC_N

Role fetchByC_N(long companyId,
                String name,
                boolean retrieveFromCache)
                throws SystemException

Finds the role 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 role, or null if a matching role could not be found

Throws:

SystemException - if a system exception occurred

findByT_S

List<Role> findByT_S(int type,
                     String subtype)
                     throws SystemException

Finds all the roles where type = ? and subtype = ?.

Parameters:

type - the type to search with

subtype - the subtype to search with

Returns:

the matching roles

Throws:

SystemException - if a system exception occurred

findByT_S

List<Role> findByT_S(int type,
                     String subtype,
                     int start,
                     int end)
                     throws SystemException

Finds a range of all the roles where type = ? and subtype = ?.

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:

type - the type to search with

subtype - the subtype to search with

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

Returns:

the range of matching roles

Throws:

SystemException - if a system exception occurred

findByT_S

List<Role> findByT_S(int type,
                     String subtype,
                     int start,
                     int end,
                     OrderByComparator orderByComparator)
                     throws SystemException

Finds an ordered range of all the roles where type = ? and subtype = ?.

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:

type - the type to search with

subtype - the subtype to search with

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching roles

Throws:

SystemException - if a system exception occurred

findByT_S_First

Role findByT_S_First(int type,
                     String subtype,
                     OrderByComparator orderByComparator)
                     throws NoSuchRoleException,
                            SystemException

Finds the first role in the ordered set where type = ? and subtype = ?.

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:

type - the type to search with

subtype - the subtype to search with

orderByComparator - the comparator to order the set by

Returns:

the first matching role

Throws:

NoSuchRoleException - if a matching role could not be found

SystemException - if a system exception occurred

findByT_S_Last

Role findByT_S_Last(int type,
                    String subtype,
                    OrderByComparator orderByComparator)
                    throws NoSuchRoleException,
                           SystemException

Finds the last role in the ordered set where type = ? and subtype = ?.

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:

type - the type to search with

subtype - the subtype to search with

orderByComparator - the comparator to order the set by

Returns:

the last matching role

Throws:

NoSuchRoleException - if a matching role could not be found

SystemException - if a system exception occurred

findByT_S_PrevAndNext

Role[] findByT_S_PrevAndNext(long roleId,
                             int type,
                             String subtype,
                             OrderByComparator orderByComparator)
                             throws NoSuchRoleException,
                                    SystemException

Finds the roles before and after the current role in the ordered set where type = ? and subtype = ?.

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:

roleId - the primary key of the current role

type - the type to search with

subtype - the subtype to search with

orderByComparator - the comparator to order the set by

Returns:

the previous, current, and next role

Throws:

NoSuchRoleException - if a role with the primary key could not be found

SystemException - if a system exception occurred

findByC_C_C

Role findByC_C_C(long companyId,
                 long classNameId,
                 long classPK)
                 throws NoSuchRoleException,
                        SystemException

Finds the role where companyId = ? and classNameId = ? and classPK = ? or throws a NoSuchRoleException if it could not be found.

Parameters:

companyId - the company id to search with

classNameId - the class name id to search with

classPK - the class p k to search with

Returns:

the matching role

Throws:

NoSuchRoleException - if a matching role could not be found

SystemException - if a system exception occurred

fetchByC_C_C

Role fetchByC_C_C(long companyId,
                  long classNameId,
                  long classPK)
                  throws SystemException

Finds the role where companyId = ? and classNameId = ? and classPK = ? or returns null if it could not be found. Uses the finder cache.

Parameters:

companyId - the company id to search with

classNameId - the class name id to search with

classPK - the class p k to search with

Returns:

the matching role, or null if a matching role could not be found

Throws:

SystemException - if a system exception occurred

fetchByC_C_C

Role fetchByC_C_C(long companyId,
                  long classNameId,
                  long classPK,
                  boolean retrieveFromCache)
                  throws SystemException

Finds the role where companyId = ? and classNameId = ? and classPK = ? or returns null if it could not be found, optionally using the finder cache.

Parameters:

companyId - the company id to search with

classNameId - the class name id to search with

classPK - the class p k to search with

Returns:

the matching role, or null if a matching role could not be found

Throws:

SystemException - if a system exception occurred

findAll

List<Role> findAll()
                   throws SystemException

Finds all the roles.

Returns:

the roles

Throws:

SystemException - if a system exception occurred

findAll

List<Role> findAll(int start,
                   int end)
                   throws SystemException

Finds a range of all the roles.

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 roles to return

end - the upper bound of the range of roles to return (not inclusive)

Returns:

the range of roles

Throws:

SystemException - if a system exception occurred

findAll

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

Finds an ordered range of all the roles.

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 roles to return

end - the upper bound of the range of roles to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of roles

Throws:

SystemException - if a system exception occurred

removeByCompanyId

void removeByCompanyId(long companyId)
                       throws SystemException

Removes all the roles where companyId = ? from the database.

Parameters:

companyId - the company id to search with

Throws:

SystemException - if a system exception occurred

removeBySubtype

void removeBySubtype(String subtype)
                     throws SystemException

Removes all the roles where subtype = ? from the database.

Parameters:

subtype - the subtype to search with

Throws:

SystemException - if a system exception occurred

removeByC_N

void removeByC_N(long companyId,
                 String name)
                 throws NoSuchRoleException,
                        SystemException

Removes the role 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

NoSuchRoleException

removeByT_S

void removeByT_S(int type,
                 String subtype)
                 throws SystemException

Removes all the roles where type = ? and subtype = ? from the database.

Parameters:

type - the type to search with

subtype - the subtype to search with

Throws:

SystemException - if a system exception occurred

removeByC_C_C

void removeByC_C_C(long companyId,
                   long classNameId,
                   long classPK)
                   throws NoSuchRoleException,
                          SystemException

Removes the role where companyId = ? and classNameId = ? and classPK = ? from the database.

Parameters:

companyId - the company id to search with

classNameId - the class name id to search with

classPK - the class p k to search with

Throws:

SystemException - if a system exception occurred

NoSuchRoleException

removeAll

void removeAll()
               throws SystemException

Removes all the roles from the database.

Throws:

SystemException - if a system exception occurred

countByCompanyId

int countByCompanyId(long companyId)
                     throws SystemException

Counts all the roles where companyId = ?.

Parameters:

companyId - the company id to search with

Returns:

the number of matching roles

Throws:

SystemException - if a system exception occurred

countBySubtype

int countBySubtype(String subtype)
                   throws SystemException

Counts all the roles where subtype = ?.

Parameters:

subtype - the subtype to search with

Returns:

the number of matching roles

Throws:

SystemException - if a system exception occurred

countByC_N

int countByC_N(long companyId,
               String name)
               throws SystemException

Counts all the roles where companyId = ? and name = ?.

Parameters:

companyId - the company id to search with

name - the name to search with

Returns:

the number of matching roles

Throws:

SystemException - if a system exception occurred

countByT_S

int countByT_S(int type,
               String subtype)
               throws SystemException

Counts all the roles where type = ? and subtype = ?.

Parameters:

type - the type to search with

subtype - the subtype to search with

Returns:

the number of matching roles

Throws:

SystemException - if a system exception occurred

countByC_C_C

int countByC_C_C(long companyId,
                 long classNameId,
                 long classPK)
                 throws SystemException

Counts all the roles where companyId = ? and classNameId = ? and classPK = ?.

Parameters:

companyId - the company id to search with

classNameId - the class name id to search with

classPK - the class p k to search with

Returns:

the number of matching roles

Throws:

SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException

Counts all the roles.

Returns:

the number of roles

Throws:

SystemException - if a system exception occurred

getGroups

List<Group> getGroups(long pk)
                      throws SystemException

Gets all the groups associated with the role.

Parameters:

pk - the primary key of the role to get the associated groups for

Returns:

the groups associated with the role

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

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 role to get the associated groups for

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

Returns:

the range of groups associated with the role

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

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 role to get the associated groups for

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of groups associated with the role

Throws:

SystemException - if a system exception occurred

getGroupsSize

int getGroupsSize(long pk)
                  throws SystemException

Gets the number of groups associated with the role.

Parameters:

pk - the primary key of the role to get the number of associated groups for

Returns:

the number of groups associated with the role

Throws:

SystemException - if a system exception occurred

containsGroup

boolean containsGroup(long pk,
                      long groupPK)
                      throws SystemException

Determines whether the group is associated with the role.

Parameters:

pk - the primary key of the role

groupPK - the primary key of the group

Returns:

whether the group is associated with the role

Throws:

SystemException - if a system exception occurred

containsGroups

boolean containsGroups(long pk)
                       throws SystemException

Determines whether the role has any groups associated with it.

Parameters:

pk - the primary key of the role to check for associations with groups

Returns:

whether the role 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 role and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

group - the group

Throws:

SystemException - if a system exception occurred

addGroups

void addGroups(long pk,
               long[] groupPKs)
               throws SystemException

Adds an association between the role and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

groups - the groups

Throws:

SystemException - if a system exception occurred

clearGroups

void clearGroups(long pk)
                 throws SystemException

Clears all associations between the role and its groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role 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 role and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role and the group. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

group - the group

Throws:

SystemException - if a system exception occurred

removeGroups

void removeGroups(long pk,
                  long[] groupPKs)
                  throws SystemException

Removes the association between the role and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role and the groups. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role, 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 role to set the associations for

groupPKs - the primary keys of the groups to be associated with the role

Throws:

SystemException - if a system exception occurred

setGroups

void setGroups(long pk,
               List<Group> groups)
               throws SystemException

Sets the groups associated with the role, 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 role to set the associations for

groups - the groups to be associated with the role

Throws:

SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk)
                                throws SystemException

Gets all the permissions associated with the role.

Parameters:

pk - the primary key of the role to get the associated permissions for

Returns:

the permissions associated with the role

Throws:

SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk,
                                int start,
                                int end)
                                throws SystemException

Gets a range of all the permissions associated with the role.

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 role to get the associated permissions for

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

Returns:

the range of permissions associated with the role

Throws:

SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                                throws SystemException

Gets an ordered range of all the permissions associated with the role.

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 role to get the associated permissions for

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of permissions associated with the role

Throws:

SystemException - if a system exception occurred

getPermissionsSize

int getPermissionsSize(long pk)
                       throws SystemException

Gets the number of permissions associated with the role.

Parameters:

pk - the primary key of the role to get the number of associated permissions for

Returns:

the number of permissions associated with the role

Throws:

SystemException - if a system exception occurred

containsPermission

boolean containsPermission(long pk,
                           long permissionPK)
                           throws SystemException

Determines whether the permission is associated with the role.

Parameters:

pk - the primary key of the role

permissionPK - the primary key of the permission

Returns:

whether the permission is associated with the role

Throws:

SystemException - if a system exception occurred

containsPermissions

boolean containsPermissions(long pk)
                            throws SystemException

Determines whether the role has any permissions associated with it.

Parameters:

pk - the primary key of the role to check for associations with permissions

Returns:

whether the role has any permissions associated with it

Throws:

SystemException - if a system exception occurred

addPermission

void addPermission(long pk,
                   long permissionPK)
                   throws SystemException

Adds an association between the role and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

permissionPK - the primary key of the permission

Throws:

SystemException - if a system exception occurred

addPermission

void addPermission(long pk,
                   Permission permission)
                   throws SystemException

Adds an association between the role and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

permission - the permission

Throws:

SystemException - if a system exception occurred

addPermissions

void addPermissions(long pk,
                    long[] permissionPKs)
                    throws SystemException

Adds an association between the role and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

permissionPKs - the primary keys of the permissions

Throws:

SystemException - if a system exception occurred

addPermissions

void addPermissions(long pk,
                    List<Permission> permissions)
                    throws SystemException

Adds an association between the role and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

permissions - the permissions

Throws:

SystemException - if a system exception occurred

clearPermissions

void clearPermissions(long pk)
                      throws SystemException

Clears all associations between the role and its permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role to clear the associated permissions from

Throws:

SystemException - if a system exception occurred

removePermission

void removePermission(long pk,
                      long permissionPK)
                      throws SystemException

Removes the association between the role and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

permissionPK - the primary key of the permission

Throws:

SystemException - if a system exception occurred

removePermission

void removePermission(long pk,
                      Permission permission)
                      throws SystemException

Removes the association between the role and the permission. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

permission - the permission

Throws:

SystemException - if a system exception occurred

removePermissions

void removePermissions(long pk,
                       long[] permissionPKs)
                       throws SystemException

Removes the association between the role and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

permissionPKs - the primary keys of the permissions

Throws:

SystemException - if a system exception occurred

removePermissions

void removePermissions(long pk,
                       List<Permission> permissions)
                       throws SystemException

Removes the association between the role and the permissions. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

permissions - the permissions

Throws:

SystemException - if a system exception occurred

setPermissions

void setPermissions(long pk,
                    long[] permissionPKs)
                    throws SystemException

Sets the permissions associated with the role, 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 role to set the associations for

permissionPKs - the primary keys of the permissions to be associated with the role

Throws:

SystemException - if a system exception occurred

setPermissions

void setPermissions(long pk,
                    List<Permission> permissions)
                    throws SystemException

Sets the permissions associated with the role, 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 role to set the associations for

permissions - the permissions to be associated with the role

Throws:

SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk)
                    throws SystemException

Gets all the users associated with the role.

Parameters:

pk - the primary key of the role to get the associated users for

Returns:

the users associated with the role

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

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 role to get the associated users for

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

Returns:

the range of users associated with the role

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

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 role to get the associated users for

start - the lower bound of the range of roles to return

end - the upper bound of the range of roles to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of users associated with the role

Throws:

SystemException - if a system exception occurred

getUsersSize

int getUsersSize(long pk)
                 throws SystemException

Gets the number of users associated with the role.

Parameters:

pk - the primary key of the role to get the number of associated users for

Returns:

the number of users associated with the role

Throws:

SystemException - if a system exception occurred

containsUser

boolean containsUser(long pk,
                     long userPK)
                     throws SystemException

Determines whether the user is associated with the role.

Parameters:

pk - the primary key of the role

userPK - the primary key of the user

Returns:

whether the user is associated with the role

Throws:

SystemException - if a system exception occurred

containsUsers

boolean containsUsers(long pk)
                      throws SystemException

Determines whether the role has any users associated with it.

Parameters:

pk - the primary key of the role to check for associations with users

Returns:

whether the role 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 role and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

user - the user

Throws:

SystemException - if a system exception occurred

addUsers

void addUsers(long pk,
              long[] userPKs)
              throws SystemException

Adds an association between the role and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

users - the users

Throws:

SystemException - if a system exception occurred

clearUsers

void clearUsers(long pk)
                throws SystemException

Clears all associations between the role and its users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role 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 role and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role and the user. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

user - the user

Throws:

SystemException - if a system exception occurred

removeUsers

void removeUsers(long pk,
                 long[] userPKs)
                 throws SystemException

Removes the association between the role and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role and the users. Also notifies the appropriate model listeners and clears the mapping table finder cache.

Parameters:

pk - the primary key of the role

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 role, 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 role to set the associations for

userPKs - the primary keys of the users to be associated with the role

Throws:

SystemException - if a system exception occurred

setUsers

void setUsers(long pk,
              List<User> users)
              throws SystemException

Sets the users associated with the role, 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 role to set the associations for

users - the users to be associated with the role

Throws:

SystemException - if a system exception occurred