RoleUtil (Liferay 6.1.2-ce-ga3 Internal API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.1.2-ce-ga3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service.persistence
Class RoleUtil

java.lang.Object
  com.liferay.portal.service.persistence.RoleUtil

public class RoleUtil
extends Object
extends Object

The persistence utility for the role service. This utility wraps RolePersistenceImpl and provides direct access to the database for CRUD operations. This utility should only be used by the service layer, as it must operate within a transaction. Never access this utility in a JSP, controller, model, or other front-end class.

Caching information and settings can be found in portal.properties

See Also:: RolePersistence, RolePersistenceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
`RoleUtil()`

Method Summary
`static void`	`addGroup(long pk, Group group)` Adds an association between the role and the group.
`static void`	`addGroup(long pk, long groupPK)` Adds an association between the role and the group.
`static void`	`addGroups(long pk, List<Group> groups)` Adds an association between the role and the groups.
`static void`	`addGroups(long pk, long[] groupPKs)` Adds an association between the role and the groups.
`static void`	`addPermission(long pk, long permissionPK)` Adds an association between the role and the permission.
`static void`	`addPermission(long pk, Permission permission)` Adds an association between the role and the permission.
`static void`	`addPermissions(long pk, List<Permission> permissions)` Adds an association between the role and the permissions.
`static void`	`addPermissions(long pk, long[] permissionPKs)` Adds an association between the role and the permissions.
`static void`	`addUser(long pk, long userPK)` Adds an association between the role and the user.
`static void`	`addUser(long pk, User user)` Adds an association between the role and the user.
`static void`	`addUsers(long pk, List<User> users)` Adds an association between the role and the users.
`static void`	`addUsers(long pk, long[] userPKs)` Adds an association between the role and the users.
`static void`	`cacheResult(List<Role> roles)` Caches the roles in the entity cache if it is enabled.
`static void`	`cacheResult(Role role)` Caches the role in the entity cache if it is enabled.
`static void`	`clearCache()`
`static void`	`clearCache(Role role)`
`static void`	`clearGroups(long pk)` Clears all associations between the role and its groups.
`static void`	`clearPermissions(long pk)` Clears all associations between the role and its permissions.
`static void`	`clearUsers(long pk)` Clears all associations between the role and its users.
`static boolean`	`containsGroup(long pk, long groupPK)` Returns `true` if the group is associated with the role.
`static boolean`	`containsGroups(long pk)` Returns `true` if the role has any groups associated with it.
`static boolean`	`containsPermission(long pk, long permissionPK)` Returns `true` if the permission is associated with the role.
`static boolean`	`containsPermissions(long pk)` Returns `true` if the role has any permissions associated with it.
`static boolean`	`containsUser(long pk, long userPK)` Returns `true` if the user is associated with the role.
`static boolean`	`containsUsers(long pk)` Returns `true` if the role has any users associated with it.
`static int`	`countAll()` Returns the number of roles.
`static int`	`countByC_C_C(long companyId, long classNameId, long classPK)` Returns the number of roles where companyId = ? and classNameId = ? and classPK = ?.
`static int`	`countByC_N(long companyId, String name)` Returns the number of roles where companyId = ? and name = ?.
`static int`	`countByCompanyId(long companyId)` Returns the number of roles where companyId = ?.
`static int`	`countByName(String name)` Returns the number of roles where name = ?.
`static int`	`countBySubtype(String subtype)` Returns the number of roles where subtype = ?.
`static int`	`countByT_S(int type, String subtype)` Returns the number of roles where type = ? and subtype = ?.
`long`	`countWithDynamicQuery(DynamicQuery dynamicQuery)`
`static Role`	`create(long roleId)` Creates a new role with the primary key.
`static 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.
`static 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.
`static Role`	`fetchByC_N(long companyId, String name)` Returns the role where companyId = ? and name = ? or returns `null` if it could not be found.
`static 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.
`static Role`	`fetchByCompanyId_First(long companyId, OrderByComparator orderByComparator)` Returns the first role in the ordered set where companyId = ?.
`static Role`	`fetchByCompanyId_Last(long companyId, OrderByComparator orderByComparator)` Returns the last role in the ordered set where companyId = ?.
`static Role`	`fetchByName_First(String name, OrderByComparator orderByComparator)` Returns the first role in the ordered set where name = ?.
`static Role`	`fetchByName_Last(String name, OrderByComparator orderByComparator)` Returns the last role in the ordered set where name = ?.
`static Role`	`fetchByPrimaryKey(long roleId)` Returns the role with the primary key or returns `null` if it could not be found.
`static Role`	`fetchBySubtype_First(String subtype, OrderByComparator orderByComparator)` Returns the first role in the ordered set where subtype = ?.
`static Role`	`fetchBySubtype_Last(String subtype, OrderByComparator orderByComparator)` Returns the last role in the ordered set where subtype = ?.
`static Role`	`fetchByT_S_First(int type, String subtype, OrderByComparator orderByComparator)` Returns the first role in the ordered set where type = ? and subtype = ?.
`static Role`	`fetchByT_S_Last(int type, String subtype, OrderByComparator orderByComparator)` Returns the last role in the ordered set where type = ? and subtype = ?.
`static int`	`filterCountByCompanyId(long companyId)` Returns the number of roles that the user has permission to view where companyId = ?.
`static int`	`filterCountByName(String name)` Returns the number of roles that the user has permission to view where name = ?.
`static int`	`filterCountBySubtype(String subtype)` Returns the number of roles that the user has permission to view where subtype = ?.
`static int`	`filterCountByT_S(int type, String subtype)` Returns the number of roles that the user has permission to view where type = ? and subtype = ?.
`static 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 = ?.
`static List<Role>`	`filterFindByCompanyId(long companyId)` Returns all the roles that the user has permission to view where companyId = ?.
`static 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 = ?.
`static 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 = ?.
`static 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 = ?.
`static List<Role>`	`filterFindByName(String name)` Returns all the roles that the user has permission to view where name = ?.
`static 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 = ?.
`static 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 = ?.
`static 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 = ?.
`static List<Role>`	`filterFindBySubtype(String subtype)` Returns all the roles that the user has permission to view where subtype = ?.
`static 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 = ?.
`static 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 = ?.
`static 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 = ?.
`static List<Role>`	`filterFindByT_S(int type, String subtype)` Returns all the roles that the user has permission to view where type = ? and subtype = ?.
`static 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 = ?.
`static 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 = ?.
`static List<Role>`	`findAll()` Returns all the roles.
`static List<Role>`	`findAll(int start, int end)` Returns a range of all the roles.
`static List<Role>`	`findAll(int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the roles.
`static 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.
`static Role`	`findByC_N(long companyId, String name)` Returns the role where companyId = ? and name = ? or throws a `NoSuchRoleException` if it could not be found.
`static Role`	`findByCompanyId_First(long companyId, OrderByComparator orderByComparator)` Returns the first role in the ordered set where companyId = ?.
`static Role`	`findByCompanyId_Last(long companyId, OrderByComparator orderByComparator)` Returns the last role in the ordered set where companyId = ?.
`static Role[]`	`findByCompanyId_PrevAndNext(long roleId, long companyId, OrderByComparator orderByComparator)` Returns the roles before and after the current role in the ordered set where companyId = ?.
`static List<Role>`	`findByCompanyId(long companyId)` Returns all the roles where companyId = ?.
`static List<Role>`	`findByCompanyId(long companyId, int start, int end)` Returns a range of all the roles where companyId = ?.
`static List<Role>`	`findByCompanyId(long companyId, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the roles where companyId = ?.
`static Role`	`findByName_First(String name, OrderByComparator orderByComparator)` Returns the first role in the ordered set where name = ?.
`static Role`	`findByName_Last(String name, OrderByComparator orderByComparator)` Returns the last role in the ordered set where name = ?.
`static Role[]`	`findByName_PrevAndNext(long roleId, String name, OrderByComparator orderByComparator)` Returns the roles before and after the current role in the ordered set where name = ?.
`static List<Role>`	`findByName(String name)` Returns all the roles where name = ?.
`static List<Role>`	`findByName(String name, int start, int end)` Returns a range of all the roles where name = ?.
`static List<Role>`	`findByName(String name, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the roles where name = ?.
`static Role`	`findByPrimaryKey(long roleId)` Returns the role with the primary key or throws a `NoSuchRoleException` if it could not be found.
`static Role`	`findBySubtype_First(String subtype, OrderByComparator orderByComparator)` Returns the first role in the ordered set where subtype = ?.
`static Role`	`findBySubtype_Last(String subtype, OrderByComparator orderByComparator)` Returns the last role in the ordered set where subtype = ?.
`static Role[]`	`findBySubtype_PrevAndNext(long roleId, String subtype, OrderByComparator orderByComparator)` Returns the roles before and after the current role in the ordered set where subtype = ?.
`static List<Role>`	`findBySubtype(String subtype)` Returns all the roles where subtype = ?.
`static List<Role>`	`findBySubtype(String subtype, int start, int end)` Returns a range of all the roles where subtype = ?.
`static List<Role>`	`findBySubtype(String subtype, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the roles where subtype = ?.
`static Role`	`findByT_S_First(int type, String subtype, OrderByComparator orderByComparator)` Returns the first role in the ordered set where type = ? and subtype = ?.
`static Role`	`findByT_S_Last(int type, String subtype, OrderByComparator orderByComparator)` Returns the last role in the ordered set where type = ? and subtype = ?.
`static 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 = ?.
`static List<Role>`	`findByT_S(int type, String subtype)` Returns all the roles where type = ? and subtype = ?.
`static List<Role>`	`findByT_S(int type, String subtype, int start, int end)` Returns a range of all the roles where type = ? and subtype = ?.
`static 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 = ?.
`static List<Role>`	`findWithDynamicQuery(DynamicQuery dynamicQuery)`
`static List<Role>`	`findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end)`
`static List<Role>`	`findWithDynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)`
`static List<Group>`	`getGroups(long pk)` Returns all the groups associated with the role.
`static List<Group>`	`getGroups(long pk, int start, int end)` Returns a range of all the groups associated with the role.
`static List<Group>`	`getGroups(long pk, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the groups associated with the role.
`static int`	`getGroupsSize(long pk)` Returns the number of groups associated with the role.
`static List<Permission>`	`getPermissions(long pk)` Returns all the permissions associated with the role.
`static List<Permission>`	`getPermissions(long pk, int start, int end)` Returns a range of all the permissions associated with the role.
`static List<Permission>`	`getPermissions(long pk, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the permissions associated with the role.
`static int`	`getPermissionsSize(long pk)` Returns the number of permissions associated with the role.
`static RolePersistence`	`getPersistence()`
`static List<User>`	`getUsers(long pk)` Returns all the users associated with the role.
`static List<User>`	`getUsers(long pk, int start, int end)` Returns a range of all the users associated with the role.
`static List<User>`	`getUsers(long pk, int start, int end, OrderByComparator orderByComparator)` Returns an ordered range of all the users associated with the role.
`static int`	`getUsersSize(long pk)` Returns the number of users associated with the role.
`static Role`	`remove(long roleId)` Removes the role with the primary key from the database.
`static void`	`removeAll()` Removes all the roles from the database.
`static Role`	`removeByC_C_C(long companyId, long classNameId, long classPK)` Removes the role where companyId = ? and classNameId = ? and classPK = ? from the database.
`static Role`	`removeByC_N(long companyId, String name)` Removes the role where companyId = ? and name = ? from the database.
`static void`	`removeByCompanyId(long companyId)` Removes all the roles where companyId = ? from the database.
`static void`	`removeByName(String name)` Removes all the roles where name = ? from the database.
`static void`	`removeBySubtype(String subtype)` Removes all the roles where subtype = ? from the database.
`static void`	`removeByT_S(int type, String subtype)` Removes all the roles where type = ? and subtype = ? from the database.
`static void`	`removeGroup(long pk, Group group)` Removes the association between the role and the group.
`static void`	`removeGroup(long pk, long groupPK)` Removes the association between the role and the group.
`static void`	`removeGroups(long pk, List<Group> groups)` Removes the association between the role and the groups.
`static void`	`removeGroups(long pk, long[] groupPKs)` Removes the association between the role and the groups.
`static void`	`removePermission(long pk, long permissionPK)` Removes the association between the role and the permission.
`static void`	`removePermission(long pk, Permission permission)` Removes the association between the role and the permission.
`static void`	`removePermissions(long pk, List<Permission> permissions)` Removes the association between the role and the permissions.
`static void`	`removePermissions(long pk, long[] permissionPKs)` Removes the association between the role and the permissions.
`static void`	`removeUser(long pk, long userPK)` Removes the association between the role and the user.
`static void`	`removeUser(long pk, User user)` Removes the association between the role and the user.
`static void`	`removeUsers(long pk, List<User> users)` Removes the association between the role and the users.
`static void`	`removeUsers(long pk, long[] userPKs)` Removes the association between the role and the users.
`static void`	`setGroups(long pk, List<Group> groups)` Sets the groups associated with the role, removing and adding associations as necessary.
`static void`	`setGroups(long pk, long[] groupPKs)` Sets the groups associated with the role, removing and adding associations as necessary.
`static void`	`setPermissions(long pk, List<Permission> permissions)` Sets the permissions associated with the role, removing and adding associations as necessary.
`static void`	`setPermissions(long pk, long[] permissionPKs)` Sets the permissions associated with the role, removing and adding associations as necessary.
`void`	`setPersistence(RolePersistence persistence)` Deprecated.
`static void`	`setUsers(long pk, List<User> users)` Sets the users associated with the role, removing and adding associations as necessary.
`static void`	`setUsers(long pk, long[] userPKs)` Sets the users associated with the role, removing and adding associations as necessary.
`static Role`	`update(Role role, boolean merge)`
`static Role`	`update(Role role, boolean merge, ServiceContext serviceContext)`
`static Role`	`updateImpl(Role role, boolean merge)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

RoleUtil

public RoleUtil()

Method Detail

clearCache

public static void clearCache()

See Also:: BasePersistence.clearCache()

clearCache

public static void clearCache(Role role)

See Also:: BasePersistence.clearCache(com.liferay.portal.model.BaseModel)

countWithDynamicQuery

public long countWithDynamicQuery(DynamicQuery dynamicQuery)
                           throws SystemException

Throws:: SystemException
See Also:: BasePersistence.countWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Role> findWithDynamicQuery(DynamicQuery dynamicQuery)
                                       throws SystemException

Throws:: SystemException
See Also:: BasePersistence.findWithDynamicQuery(DynamicQuery)

findWithDynamicQuery

public static List<Role> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                              int start,
                                              int end)
                                       throws SystemException

Throws:: SystemException
See Also:: BasePersistence.findWithDynamicQuery(DynamicQuery, int, int)

findWithDynamicQuery

public static List<Role> findWithDynamicQuery(DynamicQuery dynamicQuery,
                                              int start,
                                              int end,
                                              OrderByComparator orderByComparator)
                                       throws SystemException

Throws:: SystemException
See Also:: BasePersistence.findWithDynamicQuery(DynamicQuery, int, int, OrderByComparator)

update

public static Role update(Role role,
                          boolean merge)
                   throws SystemException

Throws:: SystemException
See Also:: BasePersistence.update(com.liferay.portal.model.BaseModel, boolean)

update

public static Role update(Role role,
                          boolean merge,
                          ServiceContext serviceContext)
                   throws SystemException

Throws:: SystemException
See Also:: BasePersistence.update(com.liferay.portal.model.BaseModel, boolean, ServiceContext)

cacheResult

public static void cacheResult(Role role)

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

Parameters:: role - the role

cacheResult

public static void cacheResult(List<Role> roles)

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

Parameters:: roles - the roles

create

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

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

public static Role updateImpl(Role role,
                              boolean merge)
                       throws SystemException

Throws:: SystemException

findByPrimaryKey

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

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

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

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

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

Returns an ordered range of all the roles where companyId = ?.

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

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

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

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

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

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

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

public static 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 = ?.

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

public static 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 = ?.

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

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

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

public static List<Role> findByName(String name,
                                    int start,
                                    int end)
                             throws SystemException

Returns a range of all the roles where name = ?.

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

public static List<Role> findByName(String name,
                                    int start,
                                    int end,
                                    OrderByComparator orderByComparator)
                             throws SystemException

Returns an ordered range of all the roles where name = ?.

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

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

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

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

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

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

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

public static 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 = ?.

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

public static 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 = ?.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public static 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 = ?.

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

public static 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 = ?.

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

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

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

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

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

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

public static 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 = ?.

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

public static 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 = ?.

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

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

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

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

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

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

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

public static 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 = ?.

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

public static 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 = ?.

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

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

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

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

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

public static List<Role> findAll()
                          throws SystemException

Returns all the roles.

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

findAll

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

Returns a range of all the roles.

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

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

Returns an ordered range of all the roles.

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

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

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

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

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

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

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

public static void removeAll()
                      throws SystemException

Removes all the roles from the database.

Throws:: SystemException - if a system exception occurred

countByCompanyId

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

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

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

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

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

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

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

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

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

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

public static int countAll()
                    throws SystemException

Returns the number of roles.

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

getGroups

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

public static List<Group> getGroups(long pk,
                                    int start,
                                    int end)
                             throws SystemException

Returns a range of all the groups associated with the role.

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

public static 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public static 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

public static List<User> getUsers(long pk,
                                  int start,
                                  int end)
                           throws SystemException

Returns a range of all the users associated with the role.

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

public static 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getPersistence

public static RolePersistence getPersistence()

setPersistence

public void setPersistence(RolePersistence persistence)

Deprecated.

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Liferay 6.1.2-ce-ga3

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.liferay.portal.service.persistence Class RoleUtil

RoleUtil

clearCache

clearCache

countWithDynamicQuery

findWithDynamicQuery

findWithDynamicQuery

findWithDynamicQuery

update

update

cacheResult

cacheResult

create

remove

updateImpl

findByPrimaryKey

fetchByPrimaryKey

findByCompanyId

findByCompanyId

findByCompanyId

findByCompanyId_First

fetchByCompanyId_First

findByCompanyId_Last

fetchByCompanyId_Last

findByCompanyId_PrevAndNext

filterFindByCompanyId

filterFindByCompanyId

filterFindByCompanyId

filterFindByCompanyId_PrevAndNext

findByName

findByName

findByName

findByName_First

fetchByName_First

findByName_Last

fetchByName_Last

findByName_PrevAndNext

filterFindByName

filterFindByName

filterFindByName

filterFindByName_PrevAndNext

findBySubtype

findBySubtype

findBySubtype

findBySubtype_First

fetchBySubtype_First

findBySubtype_Last

fetchBySubtype_Last

findBySubtype_PrevAndNext

filterFindBySubtype

filterFindBySubtype

filterFindBySubtype

filterFindBySubtype_PrevAndNext

findByC_N

fetchByC_N

fetchByC_N

findByT_S

findByT_S

findByT_S

findByT_S_First

fetchByT_S_First

findByT_S_Last

fetchByT_S_Last

findByT_S_PrevAndNext

filterFindByT_S

filterFindByT_S

filterFindByT_S

filterFindByT_S_PrevAndNext

findByC_C_C

fetchByC_C_C

fetchByC_C_C

findAll

findAll

findAll

removeByCompanyId

removeByName

removeBySubtype

removeByC_N

removeByT_S

removeByC_C_C

com.liferay.portal.service.persistence
Class RoleUtil