Package org.opencastproject.list.common.query

Class UsersListQuery

java.lang.Object

org.opencastproject.list.api.DefaultResourceListQuery

org.opencastproject.list.common.query.UsersListQuery

All Implemented Interfaces:

ResourceListQuery

public class UsersListQuery
extends DefaultResourceListQuery

Query for the users list. The following filters can be used:

• name
• role
• provider

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER_NAME_NAME
static final String	FILTER_PROVIDER_NAME
static final String	FILTER_ROLE_NAME
static final String	FILTER_TEXT_NAME

Fields inherited from class org.opencastproject.list.api.DefaultResourceListQuery

availableFilters, sortBy

Constructor Summary

Constructors

Constructor	Description
UsersListQuery()

Method Summary

Modifier and Type	Method	Description
static ResourceListFilter<String>	createNameFilter(Optional<String> name)	Create a new ResourceListFilter based on a name
static ResourceListFilter<String>	createProviderFilter(Optional<String> provider)	Create a new ResourceListFilter based on a provider
static ResourceListFilter<String>	createRoleFilter(Optional<String> role)	Create a new ResourceListFilter based on a role
Optional<String>	getName()	Returns an Optional containing the name used to filter if set
Optional<String>	getProvider()	Returns an Optional containing the provider used to filter if set
Optional<String>	getRole()	Returns an Optional containing the role used to filter if set
void	withName(String name)	Add a ResourceListFilter filter to the query with the given name
void	withProvider(String provider)	Add a ResourceListFilter filter to the query with the given provider
void	withRole(String role)	Add a ResourceListFilter filter to the query with the given role

Methods inherited from class org.opencastproject.list.api.DefaultResourceListQuery

addFilter, getAvailableFilters, getFilter, getFilters, getFilterValue, getLimit, getOffset, getSortBy, hasFilter, removeFilter, setLimit, setOffset

Methods inherited from class java.lang.Object

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

Field Details

FILTER_NAME_NAME

public static final String FILTER_NAME_NAME

See Also:

• Constant Field Values

FILTER_ROLE_NAME

public static final String FILTER_ROLE_NAME

See Also:

• Constant Field Values

FILTER_PROVIDER_NAME

public static final String FILTER_PROVIDER_NAME

See Also:

• Constant Field Values

FILTER_TEXT_NAME

public static final String FILTER_TEXT_NAME

See Also:

• Constant Field Values

Constructor Details

UsersListQuery

public UsersListQuery()

Method Details

withName

public void withName(String name)

Add a ResourceListFilter filter to the query with the given name

Parameters:

name - the name to filter for

getName

public Optional<String> getName()

Returns an Optional containing the name used to filter if set

Returns:

an Optional containing the name or none.

withRole

public void withRole(String role)

Add a ResourceListFilter filter to the query with the given role

Parameters:

role - the role to filter for

getRole

public Optional<String> getRole()

Returns an Optional containing the role used to filter if set

Returns:

an Optional containing the role or none.

withProvider

public void withProvider(String provider)

Add a ResourceListFilter filter to the query with the given provider

Parameters:

provider - the provider to filter for

getProvider

public Optional<String> getProvider()

Returns an Optional containing the provider used to filter if set

Returns:

an Optional containing the provider or none.

createNameFilter

public static ResourceListFilter<String> createNameFilter(Optional<String> name)

Create a new ResourceListFilter based on a name

Parameters:

name - the name to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a name based query

createRoleFilter

public static ResourceListFilter<String> createRoleFilter(Optional<String> role)

Create a new ResourceListFilter based on a role

Parameters:

role - the role to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a role based query

createProviderFilter

public static ResourceListFilter<String> createProviderFilter(Optional<String> provider)

Create a new ResourceListFilter based on a provider

Parameters:

provider - the provider to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a provider based query