Package org.opencastproject.list.common.query

Class JobsListQuery

java.lang.Object

org.opencastproject.list.api.DefaultResourceListQuery

org.opencastproject.list.common.query.JobsListQuery

All Implemented Interfaces:

ResourceListQuery

public class JobsListQuery
extends DefaultResourceListQuery

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

• hostname
• status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	FILTER_LABEL_HOSTNAME	Hostname filter label.
static final String	FILTER_LABEL_NODE_NAME	NodeName filter label.
static final String	FILTER_LABEL_STATUS	Status filter label.
static final String	FILTER_NAME_HOSTNAME	Hostname filter name.
static final String	FILTER_NAME_NODE_NAME	NodeName filter name.
static final String	FILTER_NAME_STATUS	Status filter name.

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

availableFilters, sortBy

Constructor Summary

Constructors

Constructor	Description
JobsListQuery()	Default constructor.
JobsListQuery(ResourceListQuery query)	Copy constructor for the base class ResourceListQuery.

Method Summary

Modifier and Type	Method	Description
static <String> ResourceListFilter<String>	createFreeTextFilter(Optional<String> value)	Create a new ResourceListFilter based on a free text.
static <String> ResourceListFilter<String>	createHostnameFilter(Optional<String> value)	Create a new ResourceListFilter based on a hostname.
static ResourceListFilter<String>	createNodeNameFilter(Optional<String> value)	Create a new ResourceListFilter based on a nodeName.
static <String> ResourceListFilter<String>	createStatusFilter(Optional<String> value)	Create a new ResourceListFilter based on a status.
Optional<String>	getFreeText()	Returns an Optional containing the free text used to filter if set.
Optional<String>	getHostname()	Returns an Optional containing the hostname used to filter if set.
Optional<String>	getNodeName()	Returns an Optional containing the node name used to filter if set.
Optional<String>	getStatus()	Returns an Optional containing the status used to filter if set.
void	withFreeText(String freeText)	Add a ResourceListFilter filter to the query with the given free text.
void	withHostname(String hostname)	Add a ResourceListFilter filter to the query with the given hostname.
void	withNodeName(String nodeName)	Add a ResourceListFilter filter to the query with the given node 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_HOSTNAME

public static final String FILTER_NAME_HOSTNAME

Hostname filter name.

See Also:

• Constant Field Values

FILTER_LABEL_HOSTNAME

public static final String FILTER_LABEL_HOSTNAME

Hostname filter label.

See Also:

• Constant Field Values

FILTER_NAME_NODE_NAME

public static final String FILTER_NAME_NODE_NAME

NodeName filter name.

See Also:

• Constant Field Values

FILTER_LABEL_NODE_NAME

public static final String FILTER_LABEL_NODE_NAME

NodeName filter label.

See Also:

• Constant Field Values

FILTER_NAME_STATUS

public static final String FILTER_NAME_STATUS

Status filter name.

See Also:

• Constant Field Values

FILTER_LABEL_STATUS

public static final String FILTER_LABEL_STATUS

Status filter label.

See Also:

• Constant Field Values

Constructor Details

JobsListQuery

public JobsListQuery()

Default constructor.

JobsListQuery

public JobsListQuery(ResourceListQuery query)

Copy constructor for the base class ResourceListQuery.

Parameters:

query - copy values from the given query

Method Details

withHostname

public void withHostname(String hostname)

Add a ResourceListFilter filter to the query with the given hostname.

Parameters:

hostname - the hostname to filter for

withNodeName

public void withNodeName(String nodeName)

Add a ResourceListFilter filter to the query with the given node name.

Parameters:

nodeName - the node name to filter for

withStatus

public void withStatus(String status)

Add a ResourceListFilter filter to the query with the given status.

Parameters:

status - the status to filter for

withFreeText

public void withFreeText(String freeText)

Add a ResourceListFilter filter to the query with the given free text.

Parameters:

freeText - the free text to filter for

getHostname

public Optional<String> getHostname()

Returns an Optional containing the hostname used to filter if set. Optional.empty() otherwise.

Returns:

an Optional containing the hostname or none.

getNodeName

public Optional<String> getNodeName()

Returns an Optional containing the node name used to filter if set. Optional.empty() otherwise.

Returns:

an Optional containing the node name or none.

getStatus

public Optional<String> getStatus()

Returns an Optional containing the status used to filter if set. Optional.empty() otherwise.

Returns:

an Optional containing the status or none.

getFreeText

public Optional<String> getFreeText()

Returns an Optional containing the free text used to filter if set. Optional.empty() otherwise.

Returns:

an Optional containing the free text or none.

createHostnameFilter

public static <String> ResourceListFilter<String> createHostnameFilter(Optional<String> value)

Create a new ResourceListFilter based on a hostname.

Parameters:

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

Returns:

a new ResourceListFilter for a hostname based query

createNodeNameFilter

public static ResourceListFilter<String> createNodeNameFilter(Optional<String> value)

Create a new ResourceListFilter based on a nodeName.

Parameters:

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

Returns:

a new ResourceListFilter for a nodeName based query

createStatusFilter

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

Create a new ResourceListFilter based on a status.

Parameters:

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

Returns:

a new ResourceListFilter for a status based query

createFreeTextFilter

public static <String> ResourceListFilter<String> createFreeTextFilter(Optional<String> value)

Create a new ResourceListFilter based on a free text.

Parameters:

value - the free text to filter on wrapped in an Optional or Optional.empty()

Returns:

a new ResourceListFilter for a free text based query