Package africa.absa.inception.security

Class Users

java.lang.Object

africa.absa.inception.security.Users

All Implemented Interfaces:

Serializable

public class Users
extends Object
implements Serializable

The Users class holds the results of a request to retrieve a list of users.

Author:

Marcus Portmann

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
Users()	Constructs a new Users.
Users(UUID userDirectoryId, List<User> users, long total, String filter, UserSortBy sortBy, africa.absa.inception.core.sorting.SortDirection sortDirection, Integer pageIndex, Integer pageSize)	Constructs a new Users.

Method Summary

Modifier and Type	Method	Description
String	getFilter()	Returns the optional filter that was applied to the users.
Integer	getPageIndex()	Returns the optional page index.
Integer	getPageSize()	Returns the optional page size.
UserSortBy	getSortBy()	Returns the optional method used to sort the users e.g.
africa.absa.inception.core.sorting.SortDirection	getSortDirection()	Returns the optional sort direction that was applied to the users.
Long	getTotal()	Returns the total number of users.
UUID	getUserDirectoryId()	Returns the Universally Unique Identifier (UUID) for the user directory the users are associated with.
List<User>	getUsers()	Returns the users.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Users

public Users()

Constructs a new Users.

Users

public Users(UUID userDirectoryId,
             List<User> users,
             long total,
             String filter,
             UserSortBy sortBy,
             africa.absa.inception.core.sorting.SortDirection sortDirection,
             Integer pageIndex,
             Integer pageSize)

Constructs a new Users.

Parameters:

userDirectoryId - the Universally Unique Identifier (UUID) for the user directory the users are associated with

users - the users

total - the total number of users

filter - the optional filter that was applied to the users

sortBy - the optional method used to sort the users e.g. by name

sortDirection - the optional sort direction that was applied to the users

pageIndex - the optional page index

pageSize - the optional page size

Method Detail

getFilter

public String getFilter()

Returns the optional filter that was applied to the users.

Returns:

the optional filter that was applied to the users

getPageIndex

public Integer getPageIndex()

Returns the optional page index.

Returns:

the optional page index

getPageSize

public Integer getPageSize()

Returns the optional page size.

Returns:

the optional page size

getSortBy

public UserSortBy getSortBy()

Returns the optional method used to sort the users e.g. by name.

Returns:

the optional method used to sort the users

getSortDirection

public africa.absa.inception.core.sorting.SortDirection getSortDirection()

Returns the optional sort direction that was applied to the users.

Returns:

the optional sort direction that was applied to the users

getTotal

public Long getTotal()

Returns the total number of users.

Returns:

the total number of users

getUserDirectoryId

public UUID getUserDirectoryId()

Returns the Universally Unique Identifier (UUID) for the user directory the users are associated with.

Returns:

the Universally Unique Identifier (UUID) for the user directory the users are associated with

getUsers

public List<User> getUsers()

Returns the users.

Returns:

the users