Package com.commercetools.api.models.state

Interface StateResourceIdentifier

All Superinterfaces:

Identifiable<State>, ResourceIdentifier, WithKey

public interface StateResourceIdentifier
extends ResourceIdentifier, Identifiable<State>

ResourceIdentifier to a State. Either id or key is required. If both are set, an InvalidJsonInput error is returned.

Example to create an instance using the builder pattern

     StateResourceIdentifier stateResourceIdentifier = StateResourceIdentifier.builder()
             .build()
 

Field Summary

Fields

Modifier and Type	Field	Description
static final String	STATE	discriminator value for StateResourceIdentifier

Method Summary

Modifier and Type	Method	Description
static StateResourceIdentifierBuilder	builder()	builder factory method for StateResourceIdentifier
static StateResourceIdentifierBuilder	builder(StateResourceIdentifier template)	create builder for StateResourceIdentifier instance
StateResourceIdentifier	copyDeep()
static StateResourceIdentifier	deepCopy(StateResourceIdentifier template)	factory method to create a deep copy of StateResourceIdentifier
String	getId()	Unique identifier of the referenced State.
String	getKey()	User-defined unique identifier of the referenced State.
static StateResourceIdentifier	of()	factory method
static StateResourceIdentifier	of(StateResourceIdentifier template)	factory method to create a shallow copy StateResourceIdentifier
void	setId(String id)	Unique identifier of the referenced State.
void	setKey(String key)	User-defined unique identifier of the referenced State.
static com.fasterxml.jackson.core.type.TypeReference<StateResourceIdentifier>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withStateResourceIdentifier(Function<StateResourceIdentifier,T> helper)	accessor map function

Methods inherited from interface com.commercetools.api.models.common.ResourceIdentifier

getTypeId, withResourceIdentifier

Field Details

STATE

static final String STATE

discriminator value for StateResourceIdentifier

See Also:

• Constant Field Values

Method Details

getId

String getId()

Unique identifier of the referenced State. Required if key is absent.

Specified by:

getId in interface Identifiable<State>

Specified by:

getId in interface ResourceIdentifier

Returns:

id

getKey

String getKey()

User-defined unique identifier of the referenced State. Required if id is absent.

Specified by:

getKey in interface ResourceIdentifier

Specified by:

getKey in interface WithKey

Returns:

key

setId

void setId(String id)

Unique identifier of the referenced State. Required if key is absent.

Specified by:

setId in interface ResourceIdentifier

Parameters:

id - value to be set

setKey

void setKey(String key)

User-defined unique identifier of the referenced State. Required if id is absent.

Specified by:

setKey in interface ResourceIdentifier

Parameters:

key - value to be set

of

static StateResourceIdentifier of()

factory method

Returns:

instance of StateResourceIdentifier

of

static StateResourceIdentifier of(StateResourceIdentifier template)

factory method to create a shallow copy StateResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

copyDeep

StateResourceIdentifier copyDeep()

Specified by:

copyDeep in interface ResourceIdentifier

deepCopy

@Nullable
static StateResourceIdentifier deepCopy(@Nullable
 StateResourceIdentifier template)

factory method to create a deep copy of StateResourceIdentifier

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static StateResourceIdentifierBuilder builder()

builder factory method for StateResourceIdentifier

Returns:

builder

builder

static StateResourceIdentifierBuilder builder(StateResourceIdentifier template)

create builder for StateResourceIdentifier instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withStateResourceIdentifier

default <T> T withStateResourceIdentifier(Function<StateResourceIdentifier,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

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

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference