SequenceDefinitionModel (Flowable Work 3.11.0)

All Known Implementing Classes:

BaseSequenceDefinitionModel
```
public interface SequenceDefinitionModel
```
Author:

Filip Hrisafov

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface SequenceDefinitionModel.Format

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`String`	`getDescription()`	Returns the optional description of this sequence definition, describing where and how it might be used.
`SequenceDefinitionModel.Format`	`getFormat()`	The format that should be used when generating the sequence.
`int`	`getIncrement()`	The increment step of the sequence.
`String`	`getKey()`	Returns the business key usually used to reference or lookup a query definition regardless of its version.
`Long`	`getMax()`	The maximum value that the sequence can reach.
`Long`	`getMin()`	The minimum value that the sequence can reach.
`String`	`getName()`	Returns the name of this sequence definition.
`Long`	`getStart()`	The first sequence number that should be generated
`boolean`	`isCycle()`	Whether the sequence is allowed to cycle, i.e.

- Method Detail
  - getKey
```
String getKey()
```
    Returns the business key usually used to reference or lookup a query definition regardless of its version.
  - getName
```
String getName()
```
    Returns the name of this sequence definition.
  - getDescription
```
String getDescription()
```
    Returns the optional description of this sequence definition, describing where and how it might be used.
  - getStart
```
Long getStart()
```
    The first sequence number that should be generated
  - getIncrement
```
int getIncrement()
```
    The increment step of the sequence. It must be positive or negative, but not 0. If the value is negative then the sequence is descending, otherwise it is ascending.
  - isCycle
```
boolean isCycle()
```
    Whether the sequence is allowed to cycle, i.e. continue generating values when the minimum or maximum is reached. After an ascending sequence reaches its maximum value, it generates its minimum value. After a descending sequence reaches its minimum, it generates its maximum value.
  - getMax
```
Long getMax()
```
    The maximum value that the sequence can reach. It must be larger than the start and min values.
  - getMin
```
Long getMin()
```
    The minimum value that the sequence can reach. It must be less than the start and max values.
  - getFormat
```
SequenceDefinitionModel.Format getFormat()
```
    The format that should be used when generating the sequence.