Package ch.ivyteam.ivy.security.user

Interface IRoleUsers

public interface IRoleUsers

Provide methods to get users that own a role by:

• directly assigned to it (assignedPaged(), assignedPaged(int))
• directly assigned to it or assigned to a child role or member role (allPaged(), allPaged(int)).

Method

Since:

8.0.3

API:

This is a public API.

Method Summary

Modifier and Type	Method	Description
IPagedResult<IUser>	allPaged()	Gets all users that own this role.
IPagedResult<IUser>	allPaged(int pageSize)	Gets all users that own this role.
IPagedResult<IUser>	assignedPaged()	Gets all users that are directly assigned to this role
IPagedResult<IUser>	assignedPaged(int pageSize)	Gets all users that are directly assigned to this role

Method Detail

assignedPaged

IPagedResult<IUser> assignedPaged()

Gets all users that are directly assigned to this role

This method uses a default, system defined page size (1000) which does not harm memory and provides still good performance.

Returns:

directly assigned users

See Also:

assignedPaged(int), allPaged(), IFluentQueryExecutor.resultsPaged()

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS RoleReadUsers PERMISSION OR OWNS RoleReadUsers@SYSTEM PERMISSION

assignedPaged

IPagedResult<IUser> assignedPaged(int pageSize)

Gets all users that are directly assigned to this role

Parameters:

pageSize - the maximum number of users loaded at once into memory On paged UI tables the number of objects you display on a single page.

Returns:

directly assigned users

See Also:

assignedPaged(), allPaged()

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS RoleReadUsers PERMISSION OR OWNS RoleReadUsers@SYSTEM PERMISSION

allPaged

IPagedResult<IUser> allPaged()

Gets all users that own this role. Either by direct assignment or by assignment to a child role or member role.

This method uses a default, system defined page size (1000) which does not harm memory and provides still good performance.

Returns:

directly assigned users

See Also:

allPaged(int), assignedPaged(), IFluentQueryExecutor.resultsPaged()

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS RoleReadUsers PERMISSION OR OWNS RoleReadUsers@SYSTEM PERMISSION

allPaged

IPagedResult<IUser> allPaged(int pageSize)

Gets all users that own this role. Either by direct assignment or by assignment to a child role or member role.

Parameters:

pageSize - the maximum number of users loaded at once into memory On paged UI tables the number of objects you display on a single page.

Returns:

directly assigned users

See Also:

allPaged(), assignedPaged()

API:

This public API is available in IvyScript and Java. It has the visibility EXPERT.

Security:

SESSION OWNS RoleReadUsers PERMISSION OR OWNS RoleReadUsers@SYSTEM PERMISSION