com.haulmont.cuba.core.app

Interface UniqueNumbersAPI

All Known Implementing Classes:

UniqueNumbers

public interface UniqueNumbersAPI

Provides sequences of unique numbers based on database sequences.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAME

Method Summary

Modifier and Type	Method and Description
void	deleteSequence(java.lang.String domain) Removes sequence with specified identifier
long	getCurrentNumber(java.lang.String domain) Returns the current value of the sequence.
long	getNextNumber(java.lang.String domain) Returns the next sequence value.
void	setCurrentNumber(java.lang.String domain, long value) Set current value for the sequence.

Field Detail

NAME

static final java.lang.String NAME

See Also:

Constant Field Values

Method Detail

getNextNumber

long getNextNumber(java.lang.String domain)

Returns the next sequence value.

Parameters:

domain - sequence identifier

Returns:

next value

getCurrentNumber

long getCurrentNumber(java.lang.String domain)

Returns the current value of the sequence. For some implementations getNextNumber(String) must be called at least once beforehand.

Parameters:

domain - sequence identifier

Returns:

current value

setCurrentNumber

void setCurrentNumber(java.lang.String domain,
                      long value)

Set current value for the sequence. Next getCurrentNumber(String) invocation will return value Next getNextNumber(String) invocation will return value + increment

Parameters:

domain - sequence identifier

value - value

deleteSequence

void deleteSequence(java.lang.String domain)

Removes sequence with specified identifier

Parameters:

domain - sequence identifier

Throws:

java.lang.IllegalStateException - if sequence does not exist