Liferay 6.1.2-ce-ga3

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.

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 it 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)
          Returns true if the group is associated with the role.
 boolean containsGroups(long pk)
          Returns true if the role has any groups associated with it.
 boolean containsPermission(long pk, long permissionPK)
          Returns true if the permission is associated with the role.
 boolean containsPermissions(long pk)
          Returns true if the role has any permissions associated with it.
 boolean containsUser(long pk, long userPK)
          Returns true if the user is associated with the role.
 boolean containsUsers(long pk)
          Returns true if the role has any users associated with it.
 int countAll()
          Returns the number of roles.
 int countByC_C_C(long companyId, long classNameId, long classPK)
          Returns the number of roles where companyId = ? and classNameId = ? and classPK = ?.
 int countByC_N(long companyId, String name)
          Returns the number of roles where companyId = ? and name = ?.
 int countByCompanyId(long companyId)
          Returns the number of roles where companyId = ?.
 int countByName(String name)
          Returns the number of roles where name = ?.
 int countBySubtype(String subtype)
          Returns the number of roles where subtype = ?.
 int countByT_S(int type, String subtype)
          Returns the number of 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)
          Returns 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)
          Returns 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)
          Returns the role where companyId = ? and name = ? or returns null if it could not be found.
 Role fetchByC_N(long companyId, String name, boolean retrieveFromCache)
          Returns the role where companyId = ? and name = ? or returns null if it could not be found, optionally using the finder cache.
 Role fetchByCompanyId_First(long companyId, OrderByComparator orderByComparator)
          Returns the first role in the ordered set where companyId = ?.
 Role fetchByCompanyId_Last(long companyId, OrderByComparator orderByComparator)
          Returns the last role in the ordered set where companyId = ?.
 Role fetchByName_First(String name, OrderByComparator orderByComparator)
          Returns the first role in the ordered set where name = ?.
 Role fetchByName_Last(String name, OrderByComparator orderByComparator)
          Returns the last role in the ordered set where name = ?.
 Role fetchByPrimaryKey(long roleId)
          Returns the role with the primary key or returns null if it could not be found.
 Role fetchBySubtype_First(String subtype, OrderByComparator orderByComparator)
          Returns the first role in the ordered set where subtype = ?.
 Role fetchBySubtype_Last(String subtype, OrderByComparator orderByComparator)
          Returns the last role in the ordered set where subtype = ?.
 Role fetchByT_S_First(int type, String subtype, OrderByComparator orderByComparator)
          Returns the first role in the ordered set where type = ? and subtype = ?.
 Role fetchByT_S_Last(int type, String subtype, OrderByComparator orderByComparator)
          Returns the last role in the ordered set where type = ? and subtype = ?.
 int filterCountByCompanyId(long companyId)
          Returns the number of roles that the user has permission to view where companyId = ?.
 int filterCountByName(String name)
          Returns the number of roles that the user has permission to view where name = ?.
 int filterCountBySubtype(String subtype)
          Returns the number of roles that the user has permission to view where subtype = ?.
 int filterCountByT_S(int type, String subtype)
          Returns the number of roles that the user has permission to view where type = ? and subtype = ?.
 Role[] filterFindByCompanyId_PrevAndNext(long roleId, long companyId, OrderByComparator orderByComparator)
          Returns the roles before and after the current role in the ordered set of roles that the user has permission to view where companyId = ?.
 List<Role> filterFindByCompanyId(long companyId)
          Returns all the roles that the user has permission to view where companyId = ?.
 List<Role> filterFindByCompanyId(long companyId, int start, int end)
          Returns a range of all the roles that the user has permission to view where companyId = ?.
 List<Role> filterFindByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles that the user has permissions to view where companyId = ?.
 Role[] filterFindByName_PrevAndNext(long roleId, String name, OrderByComparator orderByComparator)
          Returns the roles before and after the current role in the ordered set of roles that the user has permission to view where name = ?.
 List<Role> filterFindByName(String name)
          Returns all the roles that the user has permission to view where name = ?.
 List<Role> filterFindByName(String name, int start, int end)
          Returns a range of all the roles that the user has permission to view where name = ?.
 List<Role> filterFindByName(String name, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles that the user has permissions to view where name = ?.
 Role[] filterFindBySubtype_PrevAndNext(long roleId, String subtype, OrderByComparator orderByComparator)
          Returns the roles before and after the current role in the ordered set of roles that the user has permission to view where subtype = ?.
 List<Role> filterFindBySubtype(String subtype)
          Returns all the roles that the user has permission to view where subtype = ?.
 List<Role> filterFindBySubtype(String subtype, int start, int end)
          Returns a range of all the roles that the user has permission to view where subtype = ?.
 List<Role> filterFindBySubtype(String subtype, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles that the user has permissions to view where subtype = ?.
 Role[] filterFindByT_S_PrevAndNext(long roleId, int type, String subtype, OrderByComparator orderByComparator)
          Returns the roles before and after the current role in the ordered set of roles that the user has permission to view where type = ? and subtype = ?.
 List<Role> filterFindByT_S(int type, String subtype)
          Returns all the roles that the user has permission to view where type = ? and subtype = ?.
 List<Role> filterFindByT_S(int type, String subtype, int start, int end)
          Returns a range of all the roles that the user has permission to view where type = ? and subtype = ?.
 List<Role> filterFindByT_S(int type, String subtype, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles that the user has permissions to view where type = ? and subtype = ?.
 List<Role> findAll()
          Returns all the roles.
 List<Role> findAll(int start, int end)
          Returns a range of all the roles.
 List<Role> findAll(int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles.
 Role findByC_C_C(long companyId, long classNameId, long classPK)
          Returns 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)
          Returns the role where companyId = ? and name = ? or throws a NoSuchRoleException if it could not be found.
 Role findByCompanyId_First(long companyId, OrderByComparator orderByComparator)
          Returns the first role in the ordered set where companyId = ?.
 Role findByCompanyId_Last(long companyId, OrderByComparator orderByComparator)
          Returns the last role in the ordered set where companyId = ?.
 Role[] findByCompanyId_PrevAndNext(long roleId, long companyId, OrderByComparator orderByComparator)
          Returns the roles before and after the current role in the ordered set where companyId = ?.
 List<Role> findByCompanyId(long companyId)
          Returns all the roles where companyId = ?.
 List<Role> findByCompanyId(long companyId, int start, int end)
          Returns a range of all the roles where companyId = ?.
 List<Role> findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles where companyId = ?.
 Role findByName_First(String name, OrderByComparator orderByComparator)
          Returns the first role in the ordered set where name = ?.
 Role findByName_Last(String name, OrderByComparator orderByComparator)
          Returns the last role in the ordered set where name = ?.
 Role[] findByName_PrevAndNext(long roleId, String name, OrderByComparator orderByComparator)
          Returns the roles before and after the current role in the ordered set where name = ?.
 List<Role> findByName(String name)
          Returns all the roles where name = ?.
 List<Role> findByName(String name, int start, int end)
          Returns a range of all the roles where name = ?.
 List<Role> findByName(String name, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles where name = ?.
 Role findByPrimaryKey(long roleId)
          Returns the role with the primary key or throws a NoSuchRoleException if it could not be found.
 Role findBySubtype_First(String subtype, OrderByComparator orderByComparator)
          Returns the first role in the ordered set where subtype = ?.
 Role findBySubtype_Last(String subtype, OrderByComparator orderByComparator)
          Returns the last role in the ordered set where subtype = ?.
 Role[] findBySubtype_PrevAndNext(long roleId, String subtype, OrderByComparator orderByComparator)
          Returns the roles before and after the current role in the ordered set where subtype = ?.
 List<Role> findBySubtype(String subtype)
          Returns all the roles where subtype = ?.
 List<Role> findBySubtype(String subtype, int start, int end)
          Returns a range of all the roles where subtype = ?.
 List<Role> findBySubtype(String subtype, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles where subtype = ?.
 Role findByT_S_First(int type, String subtype, OrderByComparator orderByComparator)
          Returns the first role in the ordered set where type = ? and subtype = ?.
 Role findByT_S_Last(int type, String subtype, OrderByComparator orderByComparator)
          Returns the last role in the ordered set where type = ? and subtype = ?.
 Role[] findByT_S_PrevAndNext(long roleId, int type, String subtype, OrderByComparator orderByComparator)
          Returns the roles before and after the current role in the ordered set where type = ? and subtype = ?.
 List<Role> findByT_S(int type, String subtype)
          Returns all the roles where type = ? and subtype = ?.
 List<Role> findByT_S(int type, String subtype, int start, int end)
          Returns a range of all the roles where type = ? and subtype = ?.
 List<Role> findByT_S(int type, String subtype, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the roles where type = ? and subtype = ?.
 List<Group> getGroups(long pk)
          Returns all the groups associated with the role.
 List<Group> getGroups(long pk, int start, int end)
          Returns a range of all the groups associated with the role.
 List<Group> getGroups(long pk, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the groups associated with the role.
 int getGroupsSize(long pk)
          Returns the number of groups associated with the role.
 List<Permission> getPermissions(long pk)
          Returns all the permissions associated with the role.
 List<Permission> getPermissions(long pk, int start, int end)
          Returns a range of all the permissions associated with the role.
 List<Permission> getPermissions(long pk, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the permissions associated with the role.
 int getPermissionsSize(long pk)
          Returns the number of permissions associated with the role.
 List<User> getUsers(long pk)
          Returns all the users associated with the role.
 List<User> getUsers(long pk, int start, int end)
          Returns a range of all the users associated with the role.
 List<User> getUsers(long pk, int start, int end, OrderByComparator orderByComparator)
          Returns an ordered range of all the users associated with the role.
 int getUsersSize(long pk)
          Returns 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.
 Role removeByC_C_C(long companyId, long classNameId, long classPK)
          Removes the role where companyId = ? and classNameId = ? and classPK = ? from the database.
 Role 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 removeByName(String name)
          Removes all the roles where name = ? 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, clearCache, closeSession, countWithDynamicQuery, fetchByPrimaryKey, findByPrimaryKey, findWithDynamicQuery, findWithDynamicQuery, findWithDynamicQuery, getDataSource, getListeners, openSession, processException, 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

cacheResult

void cacheResult(List<Role> roles)
Caches the roles in the entity cache if it is enabled.

Parameters:
roles - the roles

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
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
Returns the role with the primary key or throws a NoSuchRoleException if it could not be found.

Parameters:
roleId - the primary key of the role
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
Returns the role with the primary key or returns null if it could not be found.

Parameters:
roleId - the primary key of the role
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
Returns all the roles where companyId = ?.

Parameters:
companyId - the company ID
Returns:
the matching roles
Throws:
SystemException - if a system exception occurred

findByCompanyId

List<Role> findByCompanyId(long companyId,
                           int start,
                           int end)
                           throws SystemException
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (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
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
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
Returns the first role 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 role
Throws:
NoSuchRoleException - if a matching role could not be found
SystemException - if a system exception occurred

fetchByCompanyId_First

Role fetchByCompanyId_First(long companyId,
                            OrderByComparator orderByComparator)
                            throws SystemException
Returns the first role 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 role, or null if a matching role could not be found
Throws:
SystemException - if a system exception occurred

findByCompanyId_Last

Role findByCompanyId_Last(long companyId,
                          OrderByComparator orderByComparator)
                          throws NoSuchRoleException,
                                 SystemException
Returns the last role 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 role
Throws:
NoSuchRoleException - if a matching role could not be found
SystemException - if a system exception occurred

fetchByCompanyId_Last

Role fetchByCompanyId_Last(long companyId,
                           OrderByComparator orderByComparator)
                           throws SystemException
Returns the last role 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 role, or null if a matching role could not be found
Throws:
SystemException - if a system exception occurred

findByCompanyId_PrevAndNext

Role[] findByCompanyId_PrevAndNext(long roleId,
                                   long companyId,
                                   OrderByComparator orderByComparator)
                                   throws NoSuchRoleException,
                                          SystemException
Returns the roles before and after the current role in the ordered set where companyId = ?.

Parameters:
roleId - the primary key of the current role
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
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

filterFindByCompanyId

List<Role> filterFindByCompanyId(long companyId)
                                 throws SystemException
Returns all the roles that the user has permission to view where companyId = ?.

Parameters:
companyId - the company ID
Returns:
the matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByCompanyId

List<Role> filterFindByCompanyId(long companyId,
                                 int start,
                                 int end)
                                 throws SystemException
Returns a range of all the roles 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 roles
end - the upper bound of the range of roles (not inclusive)
Returns:
the range of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByCompanyId

List<Role> filterFindByCompanyId(long companyId,
                                 int start,
                                 int end,
                                 OrderByComparator orderByComparator)
                                 throws SystemException
Returns an ordered range of all the roles 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 roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByCompanyId_PrevAndNext

Role[] filterFindByCompanyId_PrevAndNext(long roleId,
                                         long companyId,
                                         OrderByComparator orderByComparator)
                                         throws NoSuchRoleException,
                                                SystemException
Returns the roles before and after the current role in the ordered set of roles that the user has permission to view where companyId = ?.

Parameters:
roleId - the primary key of the current role
companyId - the company ID
orderByComparator - the comparator to order the set by (optionally null)
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

findByName

List<Role> findByName(String name)
                      throws SystemException
Returns all the roles where name = ?.

Parameters:
name - the name
Returns:
the matching roles
Throws:
SystemException - if a system exception occurred

findByName

List<Role> findByName(String name,
                      int start,
                      int end)
                      throws SystemException
Returns a range of all the roles where name = ?.

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:
name - the name
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
Returns:
the range of matching roles
Throws:
SystemException - if a system exception occurred

findByName

List<Role> findByName(String name,
                      int start,
                      int end,
                      OrderByComparator orderByComparator)
                      throws SystemException
Returns an ordered range of all the roles where name = ?.

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:
name - the name
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching roles
Throws:
SystemException - if a system exception occurred

findByName_First

Role findByName_First(String name,
                      OrderByComparator orderByComparator)
                      throws NoSuchRoleException,
                             SystemException
Returns the first role in the ordered set where name = ?.

Parameters:
name - the name
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching role
Throws:
NoSuchRoleException - if a matching role could not be found
SystemException - if a system exception occurred

fetchByName_First

Role fetchByName_First(String name,
                       OrderByComparator orderByComparator)
                       throws SystemException
Returns the first role in the ordered set where name = ?.

Parameters:
name - the name
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching role, or null if a matching role could not be found
Throws:
SystemException - if a system exception occurred

findByName_Last

Role findByName_Last(String name,
                     OrderByComparator orderByComparator)
                     throws NoSuchRoleException,
                            SystemException
Returns the last role in the ordered set where name = ?.

Parameters:
name - the name
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching role
Throws:
NoSuchRoleException - if a matching role could not be found
SystemException - if a system exception occurred

fetchByName_Last

Role fetchByName_Last(String name,
                      OrderByComparator orderByComparator)
                      throws SystemException
Returns the last role in the ordered set where name = ?.

Parameters:
name - the name
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching role, or null if a matching role could not be found
Throws:
SystemException - if a system exception occurred

findByName_PrevAndNext

Role[] findByName_PrevAndNext(long roleId,
                              String name,
                              OrderByComparator orderByComparator)
                              throws NoSuchRoleException,
                                     SystemException
Returns the roles before and after the current role in the ordered set where name = ?.

Parameters:
roleId - the primary key of the current role
name - the name
orderByComparator - the comparator to order the set by (optionally null)
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

filterFindByName

List<Role> filterFindByName(String name)
                            throws SystemException
Returns all the roles that the user has permission to view where name = ?.

Parameters:
name - the name
Returns:
the matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByName

List<Role> filterFindByName(String name,
                            int start,
                            int end)
                            throws SystemException
Returns a range of all the roles that the user has permission to view where name = ?.

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:
name - the name
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
Returns:
the range of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByName

List<Role> filterFindByName(String name,
                            int start,
                            int end,
                            OrderByComparator orderByComparator)
                            throws SystemException
Returns an ordered range of all the roles that the user has permissions to view where name = ?.

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:
name - the name
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByName_PrevAndNext

Role[] filterFindByName_PrevAndNext(long roleId,
                                    String name,
                                    OrderByComparator orderByComparator)
                                    throws NoSuchRoleException,
                                           SystemException
Returns the roles before and after the current role in the ordered set of roles that the user has permission to view where name = ?.

Parameters:
roleId - the primary key of the current role
name - the name
orderByComparator - the comparator to order the set by (optionally null)
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
Returns all the roles where subtype = ?.

Parameters:
subtype - the subtype
Returns:
the matching roles
Throws:
SystemException - if a system exception occurred

findBySubtype

List<Role> findBySubtype(String subtype,
                         int start,
                         int end)
                         throws SystemException
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (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
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
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
Returns the first role in the ordered set where subtype = ?.

Parameters:
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching role
Throws:
NoSuchRoleException - if a matching role could not be found
SystemException - if a system exception occurred

fetchBySubtype_First

Role fetchBySubtype_First(String subtype,
                          OrderByComparator orderByComparator)
                          throws SystemException
Returns the first role in the ordered set where subtype = ?.

Parameters:
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching role, or null if a matching role could not be found
Throws:
SystemException - if a system exception occurred

findBySubtype_Last

Role findBySubtype_Last(String subtype,
                        OrderByComparator orderByComparator)
                        throws NoSuchRoleException,
                               SystemException
Returns the last role in the ordered set where subtype = ?.

Parameters:
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching role
Throws:
NoSuchRoleException - if a matching role could not be found
SystemException - if a system exception occurred

fetchBySubtype_Last

Role fetchBySubtype_Last(String subtype,
                         OrderByComparator orderByComparator)
                         throws SystemException
Returns the last role in the ordered set where subtype = ?.

Parameters:
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching role, or null if a matching role could not be found
Throws:
SystemException - if a system exception occurred

findBySubtype_PrevAndNext

Role[] findBySubtype_PrevAndNext(long roleId,
                                 String subtype,
                                 OrderByComparator orderByComparator)
                                 throws NoSuchRoleException,
                                        SystemException
Returns the roles before and after the current role in the ordered set where subtype = ?.

Parameters:
roleId - the primary key of the current role
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
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

filterFindBySubtype

List<Role> filterFindBySubtype(String subtype)
                               throws SystemException
Returns all the roles that the user has permission to view where subtype = ?.

Parameters:
subtype - the subtype
Returns:
the matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindBySubtype

List<Role> filterFindBySubtype(String subtype,
                               int start,
                               int end)
                               throws SystemException
Returns a range of all the roles that the user has permission to view 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
Returns:
the range of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindBySubtype

List<Role> filterFindBySubtype(String subtype,
                               int start,
                               int end,
                               OrderByComparator orderByComparator)
                               throws SystemException
Returns an ordered range of all the roles that the user has permissions to view 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindBySubtype_PrevAndNext

Role[] filterFindBySubtype_PrevAndNext(long roleId,
                                       String subtype,
                                       OrderByComparator orderByComparator)
                                       throws NoSuchRoleException,
                                              SystemException
Returns the roles before and after the current role in the ordered set of roles that the user has permission to view where subtype = ?.

Parameters:
roleId - the primary key of the current role
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
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
Returns the role where companyId = ? and name = ? or throws a NoSuchRoleException if it could not be found.

Parameters:
companyId - the company ID
name - the name
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
Returns the role 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 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
Returns 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
name - the name
retrieveFromCache - whether to use the finder cache
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
Returns all the roles where type = ? and subtype = ?.

Parameters:
type - the type
subtype - the subtype
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
Returns 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
subtype - the subtype
start - the lower bound of the range of roles
end - the upper bound of the range of roles (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
Returns 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
subtype - the subtype
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
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
Returns the first role in the ordered set where type = ? and subtype = ?.

Parameters:
type - the type
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching role
Throws:
NoSuchRoleException - if a matching role could not be found
SystemException - if a system exception occurred

fetchByT_S_First

Role fetchByT_S_First(int type,
                      String subtype,
                      OrderByComparator orderByComparator)
                      throws SystemException
Returns the first role in the ordered set where type = ? and subtype = ?.

Parameters:
type - the type
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the first matching role, or null if a matching role could not be found
Throws:
SystemException - if a system exception occurred

findByT_S_Last

Role findByT_S_Last(int type,
                    String subtype,
                    OrderByComparator orderByComparator)
                    throws NoSuchRoleException,
                           SystemException
Returns the last role in the ordered set where type = ? and subtype = ?.

Parameters:
type - the type
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching role
Throws:
NoSuchRoleException - if a matching role could not be found
SystemException - if a system exception occurred

fetchByT_S_Last

Role fetchByT_S_Last(int type,
                     String subtype,
                     OrderByComparator orderByComparator)
                     throws SystemException
Returns the last role in the ordered set where type = ? and subtype = ?.

Parameters:
type - the type
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
Returns:
the last matching role, or null if a matching role could not be found
Throws:
SystemException - if a system exception occurred

findByT_S_PrevAndNext

Role[] findByT_S_PrevAndNext(long roleId,
                             int type,
                             String subtype,
                             OrderByComparator orderByComparator)
                             throws NoSuchRoleException,
                                    SystemException
Returns the roles before and after the current role in the ordered set where type = ? and subtype = ?.

Parameters:
roleId - the primary key of the current role
type - the type
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
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

filterFindByT_S

List<Role> filterFindByT_S(int type,
                           String subtype)
                           throws SystemException
Returns all the roles that the user has permission to view where type = ? and subtype = ?.

Parameters:
type - the type
subtype - the subtype
Returns:
the matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByT_S

List<Role> filterFindByT_S(int type,
                           String subtype,
                           int start,
                           int end)
                           throws SystemException
Returns a range of all the roles that the user has permission to view 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
subtype - the subtype
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
Returns:
the range of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByT_S

List<Role> filterFindByT_S(int type,
                           String subtype,
                           int start,
                           int end,
                           OrderByComparator orderByComparator)
                           throws SystemException
Returns an ordered range of all the roles that the user has permissions to view 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
subtype - the subtype
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

filterFindByT_S_PrevAndNext

Role[] filterFindByT_S_PrevAndNext(long roleId,
                                   int type,
                                   String subtype,
                                   OrderByComparator orderByComparator)
                                   throws NoSuchRoleException,
                                          SystemException
Returns the roles before and after the current role in the ordered set of roles that the user has permission to view where type = ? and subtype = ?.

Parameters:
roleId - the primary key of the current role
type - the type
subtype - the subtype
orderByComparator - the comparator to order the set by (optionally null)
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
Returns the role where companyId = ? and classNameId = ? and classPK = ? or throws a NoSuchRoleException if it could not be found.

Parameters:
companyId - the company ID
classNameId - the class name ID
classPK - the class p k
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
Returns 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
classNameId - the class name ID
classPK - the class p k
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
Returns 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
classNameId - the class name ID
classPK - the class p k
retrieveFromCache - whether to use the finder cache
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
Returns all the roles.

Returns:
the roles
Throws:
SystemException - if a system exception occurred

findAll

List<Role> findAll(int start,
                   int end)
                   throws SystemException
Returns 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
end - the upper bound of the range of roles (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
Returns 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
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
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
Throws:
SystemException - if a system exception occurred

removeByName

void removeByName(String name)
                  throws SystemException
Removes all the roles where name = ? from the database.

Parameters:
name - the name
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
Throws:
SystemException - if a system exception occurred

removeByC_N

Role removeByC_N(long companyId,
                 String name)
                 throws NoSuchRoleException,
                        SystemException
Removes the role where companyId = ? and name = ? from the database.

Parameters:
companyId - the company ID
name - the name
Returns:
the role that was removed
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
subtype - the subtype
Throws:
SystemException - if a system exception occurred

removeByC_C_C

Role 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
classNameId - the class name ID
classPK - the class p k
Returns:
the role that was removed
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
Returns the number of roles where companyId = ?.

Parameters:
companyId - the company ID
Returns:
the number of matching roles
Throws:
SystemException - if a system exception occurred

filterCountByCompanyId

int filterCountByCompanyId(long companyId)
                           throws SystemException
Returns the number of roles that the user has permission to view where companyId = ?.

Parameters:
companyId - the company ID
Returns:
the number of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

countByName

int countByName(String name)
                throws SystemException
Returns the number of roles where name = ?.

Parameters:
name - the name
Returns:
the number of matching roles
Throws:
SystemException - if a system exception occurred

filterCountByName

int filterCountByName(String name)
                      throws SystemException
Returns the number of roles that the user has permission to view where name = ?.

Parameters:
name - the name
Returns:
the number of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

countBySubtype

int countBySubtype(String subtype)
                   throws SystemException
Returns the number of roles where subtype = ?.

Parameters:
subtype - the subtype
Returns:
the number of matching roles
Throws:
SystemException - if a system exception occurred

filterCountBySubtype

int filterCountBySubtype(String subtype)
                         throws SystemException
Returns the number of roles that the user has permission to view where subtype = ?.

Parameters:
subtype - the subtype
Returns:
the number of matching roles 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 roles where companyId = ? and name = ?.

Parameters:
companyId - the company ID
name - the name
Returns:
the number of matching roles
Throws:
SystemException - if a system exception occurred

countByT_S

int countByT_S(int type,
               String subtype)
               throws SystemException
Returns the number of roles where type = ? and subtype = ?.

Parameters:
type - the type
subtype - the subtype
Returns:
the number of matching roles
Throws:
SystemException - if a system exception occurred

filterCountByT_S

int filterCountByT_S(int type,
                     String subtype)
                     throws SystemException
Returns the number of roles that the user has permission to view where type = ? and subtype = ?.

Parameters:
type - the type
subtype - the subtype
Returns:
the number of matching roles that the user has permission to view
Throws:
SystemException - if a system exception occurred

countByC_C_C

int countByC_C_C(long companyId,
                 long classNameId,
                 long classPK)
                 throws SystemException
Returns the number of roles where companyId = ? and classNameId = ? and classPK = ?.

Parameters:
companyId - the company ID
classNameId - the class name ID
classPK - the class p k
Returns:
the number of matching roles
Throws:
SystemException - if a system exception occurred

countAll

int countAll()
             throws SystemException
Returns the number of roles.

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

getGroups

List<Group> getGroups(long pk)
                      throws SystemException
Returns all the groups associated with the role.

Parameters:
pk - the primary key of the role
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
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (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
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of groups associated with the role
Throws:
SystemException - if a system exception occurred

getGroupsSize

int getGroupsSize(long pk)
                  throws SystemException
Returns the number of groups associated with the role.

Parameters:
pk - the primary key of the role
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
Returns true if the group is associated with the role.

Parameters:
pk - the primary key of the role
groupPK - the primary key of the group
Returns:
true if the group is associated with the role; false otherwise
Throws:
SystemException - if a system exception occurred

containsGroups

boolean containsGroups(long pk)
                       throws SystemException
Returns true if the role has any groups associated with it.

Parameters:
pk - the primary key of the role to check for associations with groups
Returns:
true if the role 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 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
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
groups - the groups to be associated with the role
Throws:
SystemException - if a system exception occurred

getPermissions

List<Permission> getPermissions(long pk)
                                throws SystemException
Returns all the permissions associated with the role.

Parameters:
pk - the primary key of the role
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
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (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
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of permissions associated with the role
Throws:
SystemException - if a system exception occurred

getPermissionsSize

int getPermissionsSize(long pk)
                       throws SystemException
Returns the number of permissions associated with the role.

Parameters:
pk - the primary key of the role
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
Returns true if the permission is associated with the role.

Parameters:
pk - the primary key of the role
permissionPK - the primary key of the permission
Returns:
true if the permission is associated with the role; false otherwise
Throws:
SystemException - if a system exception occurred

containsPermissions

boolean containsPermissions(long pk)
                            throws SystemException
Returns true if the role has any permissions associated with it.

Parameters:
pk - the primary key of the role to check for associations with permissions
Returns:
true if the role has any permissions associated with it; false otherwise
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
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
permissions - the permissions to be associated with the role
Throws:
SystemException - if a system exception occurred

getUsers

List<User> getUsers(long pk)
                    throws SystemException
Returns all the users associated with the role.

Parameters:
pk - the primary key of the role
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
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (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
Returns 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
start - the lower bound of the range of roles
end - the upper bound of the range of roles (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of users associated with the role
Throws:
SystemException - if a system exception occurred

getUsersSize

int getUsersSize(long pk)
                 throws SystemException
Returns the number of users associated with the role.

Parameters:
pk - the primary key of the role
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
Returns true if the user is associated with the role.

Parameters:
pk - the primary key of the role
userPK - the primary key of the user
Returns:
true if the user is associated with the role; false otherwise
Throws:
SystemException - if a system exception occurred

containsUsers

boolean containsUsers(long pk)
                      throws SystemException
Returns true if the role has any users associated with it.

Parameters:
pk - the primary key of the role to check for associations with users
Returns:
true if the role 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 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
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
users - the users to be associated with the role
Throws:
SystemException - if a system exception occurred

Liferay 6.1.2-ce-ga3