Package org.opencastproject.capture.admin.api

Class AgentsListQuery

java.lang.Object

org.opencastproject.list.api.DefaultResourceListQuery

org.opencastproject.capture.admin.api.AgentsListQuery

All Implemented Interfaces:

ResourceListQuery

public class AgentsListQuery
extends DefaultResourceListQuery

Query for the capture-agents list. The following filters can be used:

• name
• status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER_LAST_UPDATED
static final String	FILTER_NAME_NAME
static final String	FILTER_STATUS_NAME
static final String	FILTER_TEXT_NAME

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

availableFilters, sortBy

Constructor Summary

Constructors

Constructor	Description
AgentsListQuery()

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>	createStatusFilter(Optional<String> status)	Create a new ResourceListFilter based on a state
Optional<String>	getName()	Returns an Optional containing the name used to filter if set
Optional<String>	getStatus()	Returns an Optional containing the status used to filter if set
void	withName(String name)	Add a ResourceListFilter filter to the query with the given name
void	withStatus(String status)	Add a ResourceListFilter filter to the query with the given status

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_STATUS_NAME

public static final String FILTER_STATUS_NAME

See Also:

• Constant Field Values

FILTER_LAST_UPDATED

public static final String FILTER_LAST_UPDATED

See Also:

• Constant Field Values

FILTER_TEXT_NAME

public static final String FILTER_TEXT_NAME

See Also:

• Constant Field Values

Constructor Details

AgentsListQuery

public AgentsListQuery()

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.

withStatus

public void withStatus(String status)

Add a ResourceListFilter filter to the query with the given status

Parameters:

status - the status to filter for

getStatus

public Optional<String> getStatus()

Returns an Optional containing the status used to filter if set

Returns:

an Optional containing the status 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

createStatusFilter

public static ResourceListFilter<String> createStatusFilter(Optional<String> status)

Create a new ResourceListFilter based on a state

Parameters:

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

Returns:

a new ResourceListFilter for a status based query