com.almworks.jira.structure.api.attribute

Interface VersionedRowValues

All Superinterfaces:

RowValues

All Known Implementing Classes:

VersionedRowValues.EmptyVersionedRowValues

@PublicApi
public interface VersionedRowValues
extends RowValues

This interface extends the basic RowValues interface, which allows retrieving values calculated by StructureAttributeService. In addition to the basic RowValues.get(Long, AttributeSpec) method, this interface provides information about the version of the forest and version of the items that were current when the values were calculated.

Also, the interface provides a way to retrieve AttributeTrail for each requested attribute, which is needed to correctly implement value caching.

See Also:

RowValues, StructureAttributeService

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	VersionedRowValues.EmptyVersionedRowValues Empty result implementation

Field Summary

Fields

Modifier and Type	Field and Description
static VersionedRowValues	EMPTY Constant empty result

Method Summary

Modifier and Type	Method and Description
DataVersion	getForestVersion() Returns the version of the forest (defined by ForestSpec), which was used to calculate the values.
DataVersion	getItemsVersion() Returns the global version of items, which was current when the values were calculated.

Methods inherited from interface com.almworks.jira.structure.api.attribute.RowValues

get, getTrail

Field Detail

EMPTY

static final VersionedRowValues EMPTY

Constant empty result

Method Detail

getForestVersion

@NotNull
DataVersion getForestVersion()

Returns the version of the forest (defined by ForestSpec), which was used to calculate the values. Forest version is important for "aggregate" and "propagate" values.

When values are requested for arbitrary forest (not defined by a ForestSpec), this method always returns DataVersion.ZERO.

getItemsVersion

@NotNull
DataVersion getItemsVersion()

Returns the global version of items, which was current when the values were calculated. When items change, the global items version increases, so it can be used to implement caching with invalidation.

See Also:

ItemTracker