Uses of Interface
ch.ivyteam.ivy.security.IRole

Packages that use IRole

Package	Description
ch.ivyteam.ivy.bpm.engine.client
ch.ivyteam.ivy.bpm.engine.client.sub
ch.ivyteam.ivy.security
ch.ivyteam.ivy.security.query
ch.ivyteam.ivy.security.role
ch.ivyteam.ivy.workflow	Defines the Axon Ivy workflow subsystem with interfaces for ITask and ICase.
ch.ivyteam.ivy.workflow.query
ch.ivyteam.ivy.workflow.task

Uses of IRole in ch.ivyteam.ivy.bpm.engine.client

Methods in ch.ivyteam.ivy.bpm.engine.client with parameters of type IRole

Modifier and Type	Method	Description
Optional<ITask>	TaskSelector.activator(IRole role)	Selects an active task by the activator role
RequestBuilder	SessionChooser.anonymousWithRole(IRole role)	Deprecated, for removal: This API element is subject to removal in a future version. session role will be removed with 13.1. assign the role to a user which needs to be authenticated.
RequestBuilder	SessionChooser.role(IRole role)	Execute the request as the given role

Uses of IRole in ch.ivyteam.ivy.bpm.engine.client.sub

Methods in ch.ivyteam.ivy.bpm.engine.client.sub with parameters of type IRole

Modifier and Type	Method	Description
SubRequestBuilder	SubSessionChooser.anonymousWithRole(IRole role)	Deprecated, for removal: This API element is subject to removal in a future version. session roles will be removed in 13.1. assign roles to a user.
SubRequestBuilder	SubSessionChooser.role(IRole role)	Execute the request as the given role

Uses of IRole in ch.ivyteam.ivy.security

Methods in ch.ivyteam.ivy.security that return IRole

Modifier and Type	Method	Description
IRole	IRole.findChildRole(String roleName)	Finds the child role with it's name
IRole	ISecurityContext.findRole(long roleId)	Deprecated, for removal: This API element is subject to removal in a future version. use ISecurityContext.roles().findById(securityMemberId)
default IRole	ISecurityContext.findRole(String roleName)	Deprecated, for removal: This API element is subject to removal in a future version. instead use ISecurityContext.roles().find(roleName) Migration Example: ivy.session().getSecurityContext().findRole("ivy") ==> ivy.security.roles().find("ivy")
IRole	IRole.getParent()	Returns the parent role
IRole	IPermissionAccess.getPermissionHolder()	Gets the permission holder.
IRole	IUserSubstitute.getSubstitutionRole()	Gets the substitution role
default IRole	ISecurityContext.getTopLevelRole()	Deprecated, for removal: This API element is subject to removal in a future version. instead use ISecurityContext.roles().topLevel())

Methods in ch.ivyteam.ivy.security that return types with arguments of type IRole

Modifier and Type	Method	Description
default List<IRole>	ISecurityContext.getActiveRoles()	Deprecated, for removal: This API element is subject to removal in a future version. instead use ISecurityContext.roles().active()
List<IRole>	IUser.getAllRoles()	Get all roles the user owns (directly and indirectly)
List<IRole>	IRole.getChildRoles()	Returns the child roles
List<IRole>	IRole.getRoleMembers()	Gets all direct role members of this role.
List<IRole>	IRole.getRoles()	Gets the directly owned roles.
default List<IRole>	ISecurityContext.getRoles()	Deprecated, for removal: This API element is subject to removal in a future version. instead use ISecurityContext.roles().all()
List<IRole>	IUser.getRoles()	Get roles the user owns direct

Methods in ch.ivyteam.ivy.security with parameters of type IRole

Modifier and Type	Method	Description
void	IUser.addRole(IRole role)	Add a role the user can act as
void	IRole.addRoleMember(IRole role)	Adds the given role as role member of this role.
boolean	IRoleMatcher.anyRoles(IRole... roles)	Tests if the user of this user token currently owns any the given roles.
void	ISession.assignRole(IRole role)	Deprecated, for removal: This API element is subject to removal in a future version. session role will be removed with 13.1. assign the role to a user which needs to be authenticated.
IUserSubstitute	IUser.createSubstitute(IUser mySubstitute, IRole forThisRole, String description)	Creates a new substitute for a specific role.
boolean	IUserToken.hasRole(IRole role, boolean useSessionRoles)	Test if the user of this user token currently owns a role.
boolean	IRole.isRole(IRole role)	Checks whether this or any parent role is equal with the role given
void	IUser.removeRole(IRole role)	Remove a role the user can act as
void	IRole.removeRoleMember(IRole role)	Removes the given member role from this role.
boolean	IRoleMatcher.role(IRole role)	Tests if the user of this user token currently owns the given role.
boolean	IRoleMatcher.roles(IRole... roles)	Tests if the user of this user token currently owns all the given roles.

Method parameters in ch.ivyteam.ivy.security with type arguments of type IRole

Modifier and Type	Method	Description
boolean	IRoleMatcher.anyRoles(Collection<IRole> roles)	Tests if the user of this user token currently owns any of the given roles.
boolean	IRoleMatcher.roles(Collection<IRole> roles)	Tests if the user of this user token currently owns all the given roles.

Uses of IRole in ch.ivyteam.ivy.security.query

Methods in ch.ivyteam.ivy.security.query with parameters of type IRole

Modifier and Type	Method	Description
UserQuery.FilterLink	UserQuery.IFilterableColumns.hasRole(IRole role)	Filters users which has the given role.
UserQuery.FilterLink	UserQuery.IFilterableColumns.hasRoleAssigned(IRole role)	Filters users which has the given role directly assigned.

Uses of IRole in ch.ivyteam.ivy.security.role

Methods in ch.ivyteam.ivy.security.role that return IRole

Modifier and Type	Method	Description
IRole	IRoleRepository.create(NewRole role)	Creates a new role.
IRole	IRoleRepository.create(String name)	Creates a new role.
IRole	IRoleRepository.find(String roleName)	Finds a role by its name
IRole	IRoleRepository.findById(String securityMemberId)	Finds a role by its id
IRole	IRoleRepository.topLevel()

Methods in ch.ivyteam.ivy.security.role that return types with arguments of type IRole

Modifier and Type	Method	Description
List<IRole>	IRoleRepository.active()
List<IRole>	IRoleRepository.all()

Methods in ch.ivyteam.ivy.security.role with parameters of type IRole

Modifier and Type	Method	Description
NewRole.Builder	NewRole.Builder.parentRole(IRole parentRole)

Uses of IRole in ch.ivyteam.ivy.workflow

Method parameters in ch.ivyteam.ivy.workflow with type arguments of type IRole

Modifier and Type	Method	Description
IQueryResult<ICase>	IWorkflowSession.findInvolvedCasesByRole(List<IRole> roles, IPropertyFilter<CaseProperty> filter, List<PropertyOrder<CaseProperty>> order, int startIndex, int count, boolean returnAllCount)	Deprecated, for removal: This API element is subject to removal in a future version. use CaseQuery
List<IGroup<ICase>>	IWorkflowSession.findInvolvedCasesByRoleCategories(List<IRole> roles, IPropertyFilter<CaseProperty> categoryFilter, CaseProperty categoryProperty, OrderDirection categoryPropertyOrder)	Deprecated, for removal: This API element is subject to removal in a future version. use CategoryTree.createFor(CaseQuery) instead
IQueryResult<ICase>	IWorkflowSession.findStartedCasesByRole(List<IRole> roles, IPropertyFilter<CaseProperty> filter, List<PropertyOrder<CaseProperty>> order, int startIndex, int count, boolean returnAllCount)	Deprecated, for removal: This API element is subject to removal in a future version. use CaseQuery
IQueryResult<ITask>	IWorkflowSession.findWorkedOnTasksByRole(List<IRole> roles, IPropertyFilter<TaskProperty> filter, List<PropertyOrder<TaskProperty>> order, int startIndex, int count, boolean returnAllCount)	Deprecated, for removal: This API element is subject to removal in a future version. use TaskQuery

Uses of IRole in ch.ivyteam.ivy.workflow.query

Methods in ch.ivyteam.ivy.workflow.query with parameters of type IRole

Modifier and Type	Method	Description
CaseQuery.FilterLink	CaseQuery.FilterQuery.roleCanWorkOn(IRole role)
CaseQuery.FilterLink	CaseQuery.IFilterableColumns.roleCanWorkOn(IRole role)	Filters all cases where the role can work on at least one task.
CaseQuery.FilterLink	CaseQuery.FilterQuery.roleIsInvolved(IRole role)
CaseQuery.FilterLink	CaseQuery.IFilterableColumns.roleIsInvolved(IRole role)	Filters all cases the role is involved in.
TaskQuery.FilterLink	TaskQuery.FilterQuery.roleIsInvolved(IRole role)
TaskQuery.FilterLink	TaskQuery.IFilterableColumns.roleIsInvolved(IRole role)	Filters all tasks the role is involved in.

Uses of IRole in ch.ivyteam.ivy.workflow.task

Methods in ch.ivyteam.ivy.workflow.task with parameters of type IRole

Modifier and Type	Method	Description
boolean	IActivator.isRole(IRole role)	Whether the activator is set and is the given role.