Package com.flowable.platform.engine.impl.repository

Class BaseSequenceDefinitionModel

java.lang.Object

com.flowable.platform.engine.impl.repository.BaseSequenceDefinitionModel

All Implemented Interfaces:

SequenceDefinitionModel

public class BaseSequenceDefinitionModel
extends Object
implements SequenceDefinitionModel

Author:

Filip Hrisafov

Nested Class Summary

Nested classes/interfaces inherited from interface com.flowable.platform.api.repository.SequenceDefinitionModel

SequenceDefinitionModel.Format

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	cycle
protected String	description
protected SequenceDefinitionModel.Format	format
protected int	increment
protected String	key
protected Long	max
protected Long	min
protected String	name
protected Long	start

Constructor Summary

Constructors

Constructor	Description
BaseSequenceDefinitionModel()

Method Summary

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.
void	setCycle(boolean cycle)
void	setDescription(String description)
void	setFormat(SequenceDefinitionModel.Format format)
void	setIncrement(int increment)
void	setKey(String key)
void	setMax(Long max)
void	setMin(Long min)
void	setName(String name)
void	setStart(Long start)

Methods inherited from class java.lang.Object

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

Field Details

key

protected String key

name

protected String name

description

protected String description

start

protected Long start

increment

protected int increment

cycle

protected boolean cycle

max

protected Long max

min

protected Long min

format

protected SequenceDefinitionModel.Format format

Constructor Details

BaseSequenceDefinitionModel

public BaseSequenceDefinitionModel()

Method Details

getKey

public String getKey()

Description copied from interface: SequenceDefinitionModel

Returns the business key usually used to reference or lookup a query definition regardless of its version.

Specified by:

getKey in interface SequenceDefinitionModel

setKey

public void setKey(String key)

getName

public String getName()

Description copied from interface: SequenceDefinitionModel

Returns the name of this sequence definition.

Specified by:

getName in interface SequenceDefinitionModel

setName

public void setName(String name)

getDescription

public String getDescription()

Description copied from interface: SequenceDefinitionModel

Returns the optional description of this sequence definition, describing where and how it might be used.

Specified by:

getDescription in interface SequenceDefinitionModel

setDescription

public void setDescription(String description)

getStart

public Long getStart()

Description copied from interface: SequenceDefinitionModel

The first sequence number that should be generated

Specified by:

getStart in interface SequenceDefinitionModel

setStart

public void setStart(Long start)

getIncrement

public int getIncrement()

Description copied from interface: SequenceDefinitionModel

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.

Specified by:

getIncrement in interface SequenceDefinitionModel

setIncrement

public void setIncrement(int increment)

isCycle

public boolean isCycle()

Description copied from interface: SequenceDefinitionModel

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.

Specified by:

isCycle in interface SequenceDefinitionModel

setCycle

public void setCycle(boolean cycle)

getMax

public Long getMax()

Description copied from interface: SequenceDefinitionModel

The maximum value that the sequence can reach. It must be larger than the start and min values.

Specified by:

getMax in interface SequenceDefinitionModel

setMax

public void setMax(Long max)

getMin

public Long getMin()

Description copied from interface: SequenceDefinitionModel

The minimum value that the sequence can reach. It must be less than the start and max values.

Specified by:

getMin in interface SequenceDefinitionModel

setMin

public void setMin(Long min)

getFormat

public SequenceDefinitionModel.Format getFormat()

Description copied from interface: SequenceDefinitionModel

The format that should be used when generating the sequence.

Specified by:

getFormat in interface SequenceDefinitionModel

setFormat

public void setFormat(SequenceDefinitionModel.Format format)