org.ametys.cms.search.query

Class WorkflowStepQuery

java.lang.Object

org.ametys.cms.search.query.WorkflowStepQuery

All Implemented Interfaces:

Query

public class WorkflowStepQuery
extends Object
implements Query

Represents a Query testing the current workflow step of a content. It can only be used to search on the current step.

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.cms.search.query.Query

Query.LogicalOperator, Query.Operator

Field Summary

Fields

Modifier and Type	Field and Description
private Query.LogicalOperator	_logicalOperator
private Query.Operator	_operator
private int[]	_values

Constructor Summary

Constructors

Constructor and Description
WorkflowStepQuery(int... values) Build a WorkflowStepQuery.
WorkflowStepQuery(int value) Build a WorkflowStepQuery.
WorkflowStepQuery(Query.Operator operator, int... values) Build a WorkflowStepQuery.
WorkflowStepQuery(Query.Operator operator, int value) Build a WorkflowStepQuery.
WorkflowStepQuery(Query.Operator operator, Query.LogicalOperator logicalOperator, int... values) Build a WorkflowStepQuery.

Method Summary

Modifier and Type	Method and Description
String	build() Build the solr query string representing the Query object.
boolean	equals(Object obj)
Query.LogicalOperator	getLogicalOperator() Get the logicalOperator.
Query.Operator	getOperator() Get the operator.
int[]	getValues() Get the values.
int	hashCode()

Methods inherited from class java.lang.Object

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

Field Detail

_operator

private Query.Operator _operator

_values

private int[] _values

_logicalOperator

private Query.LogicalOperator _logicalOperator

Constructor Detail

WorkflowStepQuery

public WorkflowStepQuery(int value)

Build a WorkflowStepQuery.

Parameters:

value - the step id to test.

WorkflowStepQuery

public WorkflowStepQuery(int... values)

Build a WorkflowStepQuery.

Parameters:

values - the step IDs to test.

WorkflowStepQuery

public WorkflowStepQuery(Query.Operator operator,
                         int value)

Build a WorkflowStepQuery.

Parameters:

operator - the operator.

value - the step id to test.

WorkflowStepQuery

public WorkflowStepQuery(Query.Operator operator,
                         int... values)

Build a WorkflowStepQuery.

Parameters:

operator - the operator.

values - the step IDs to test.

WorkflowStepQuery

public WorkflowStepQuery(Query.Operator operator,
                         Query.LogicalOperator logicalOperator,
                         int... values)

Build a WorkflowStepQuery.

Parameters:

operator - the operator.

logicalOperator - the logical operator.

values - the step IDs to test.

Method Detail

getOperator

public Query.Operator getOperator()

Get the operator.

Returns:

the operator

getValues

public int[] getValues()

Get the values.

Returns:

the values

getLogicalOperator

public Query.LogicalOperator getLogicalOperator()

Get the logicalOperator.

Returns:

the logicalOperator

build

public String build()
             throws QuerySyntaxException

Description copied from interface: Query

Build the solr query string representing the Query object.

Specified by:

build in interface Query

Returns:

the solr query string representing the Query object.

Throws:

QuerySyntaxException - if the query can't be built because of a syntax error.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object