Package org.camunda.bpm.client.task

Class OrderingConfig

java.lang.Object

org.camunda.bpm.client.task.OrderingConfig

public class OrderingConfig
extends Object

Class that encapsulates the client's configuration of createTime ordering.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	OrderingConfig.Direction	The direction of createTime.
static class	OrderingConfig.OrderingProperty	Static Class that encapsulates an ordering property with a field and its direction.
static enum	OrderingConfig.SortingField	The field to sort by.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final ExternalTaskClientLogger	LOG
protected final List<OrderingConfig.OrderingProperty>	orderingProperties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OrderingConfig(List<OrderingConfig.OrderingProperty> orderingProperties)	Constructor using a list of ordering properties

Method Summary

Modifier and Type	Method	Description
void	configureDirectionOnLastField(OrderingConfig.Direction direction)	Configures the OrderingConfig.Direction for the last configured field on this OrderingConfig.
void	configureField(OrderingConfig.SortingField field)	Configures the given field.
static OrderingConfig	empty()	Returns an empty config.
protected OrderingConfig.OrderingProperty	getLastConfiguredProperty()	Returns the last configured field in this OrderingConfig.
List<SortingDto>	toSortingDtos()	Converts this OrderingConfig to a list of SortingDtos.
protected OrderingConfig.OrderingProperty	validateAndGetLastConfiguredProperty()	Validates the last configured field for its direction and retrieves it.
void	validateOrderingProperties()	Validates ordering properties all have a non-null direction.

Methods inherited from class java.lang.Object

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

Field Details

LOG

protected static final ExternalTaskClientLogger LOG

orderingProperties

protected final List<OrderingConfig.OrderingProperty> orderingProperties

Constructor Details

OrderingConfig

protected OrderingConfig(List<OrderingConfig.OrderingProperty> orderingProperties)

Constructor using a list of ordering properties

Parameters:

orderingProperties - the list of ordering properties

Method Details

empty

public static OrderingConfig empty()

Returns an empty config.

configureField

public void configureField(OrderingConfig.SortingField field)

Configures the given field.

Parameters:

field - the sorting field to configure

configureDirectionOnLastField

public void configureDirectionOnLastField(OrderingConfig.Direction direction)

Configures the OrderingConfig.Direction for the last configured field on this OrderingConfig.

Parameters:

direction - the given direction, nullable.

validateAndGetLastConfiguredProperty

protected OrderingConfig.OrderingProperty validateAndGetLastConfiguredProperty()

Validates the last configured field for its direction and retrieves it.

validateOrderingProperties

public void validateOrderingProperties()

Validates ordering properties all have a non-null direction.

toSortingDtos

public List<SortingDto> toSortingDtos()

Converts this OrderingConfig to a list of SortingDtos.

getLastConfiguredProperty

protected OrderingConfig.OrderingProperty getLastConfiguredProperty()

Returns the last configured field in this OrderingConfig.