io.sphere.sdk.states

Interface State

All Superinterfaces:

CreationTimestamped, Identifiable<State>, Referenceable<State>, Resource<State>, ResourceIdentifiable<State>, ResourceView<State,State>, Timestamped, Versioned<State>, WithKey

public interface State
extends Resource<State>, WithKey

A State represents a state of a particular resource (defines a finite state machine). States can be combined together by defining transitions between each state, thus allowing to create work-flows. Each project has by default an initial LineItemState (inherited also by custom Line Items)

See Also:

StateCreateCommand, StateUpdateCommand, StateDeleteCommand, StateQuery, StateByIdGet, ItemState.getState(), Order.getState(), PaymentStatus.getState(), Product.getState(), Review.getState()

Method Summary

Modifier and Type	Method and Description
LocalizedString	getDescription()
String	getKey()
LocalizedString	getName()
Set<StateRole>	getRoles()
Set<Reference<State>>	getTransitions()
StateType	getType()
Boolean	isBuiltIn()
Boolean	isInitial()
static Reference<State>	referenceOfId(String id) Creates a reference for one item of this class by a known ID.
static String	referenceTypeId() A type hint for references which resource type is linked in a reference.
static String	resourceTypeId()
default Reference<State>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<State>	typeReference() Creates a container which contains the full Java type information to deserialize this class from JSON.

Methods inherited from interface io.sphere.sdk.models.Resource

getCreatedAt, getId, getLastModifiedAt, getVersion

Methods inherited from interface io.sphere.sdk.models.Versioned

of, of

Methods inherited from interface io.sphere.sdk.models.Referenceable

hasSameIdAs, toResourceIdentifier

Method Detail

getKey

String getKey()

Specified by:

getKey in interface WithKey

getType

StateType getType()

getName

@Nullable
LocalizedString getName()

getDescription

@Nullable
LocalizedString getDescription()

isInitial

Boolean isInitial()

isBuiltIn

Boolean isBuiltIn()

getTransitions

@Nullable
Set<Reference<State>> getTransitions()

getRoles

@Nullable
Set<StateRole> getRoles()

toReference

default Reference<State> toReference()

Description copied from interface: Referenceable

Creates a reference to this resource, the reference may not be filled.

Specified by:

toReference in interface Referenceable<State>

Specified by:

toReference in interface Resource<State>

Returns:

reference

referenceTypeId

static String referenceTypeId()

A type hint for references which resource type is linked in a reference.

Returns:

type hint

See Also:

Reference.getTypeId()

resourceTypeId

static String resourceTypeId()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<State> typeReference()

Creates a container which contains the full Java type information to deserialize this class from JSON.

Returns:

type reference

See Also:

SphereJsonUtils.readObject(byte[], TypeReference), SphereJsonUtils.readObject(String, TypeReference), SphereJsonUtils.readObject(com.fasterxml.jackson.databind.JsonNode, TypeReference), SphereJsonUtils.readObjectFromResource(String, TypeReference)

referenceOfId

static Reference<State> referenceOfId(String id)

Creates a reference for one item of this class by a known ID.

An example for categories but this applies for other resources, too:

final String categoryIdFromFormOrSession = "84ac4271-0fec-49d0-9fee-55586c565c58";
final Reference<Category> categoryReference = Category.referenceOfId(categoryIdFromFormOrSession);
assertThat(categoryReference.getId()).isEqualTo(categoryIdFromFormOrSession);
See the test code.

If you already have a resource object, then use toReference() instead:

final Category category = getCategory1();
final Reference<Category> categoryReference = category.toReference();
assertThat(category.getId()).isEqualTo(categoryReference.getId());
See the test code.

Parameters:

id - the ID of the resource which should be referenced.

Returns:

reference