Package com.commercetools.api.models.custom_object

Interface GenericCustomObject<TValue>

Type Parameters:

TValue - The type of the value of this custom object.

All Superinterfaces:

BaseResource, DomainResource<GenericCustomObject<TValue>>, Identifiable<GenericCustomObject<TValue>>, Referencable<GenericCustomObject<TValue>>, Versioned<GenericCustomObject<TValue>>

public interface GenericCustomObject<TValue>
extends BaseResource, DomainResource<GenericCustomObject<TValue>>, Referencable<GenericCustomObject<TValue>>

entity to implement a type safe generic custom object

Method Summary

Modifier and Type	Method	Description
static <T> GenericCustomObjectBuilder<T>	builder(GenericCustomObject<T> template)
static <T> GenericCustomObjectBuilder<T>	builder(T value)
static <TValue> GenericCustomObject<TValue>	deepCopy(GenericCustomObject<TValue> template)	factory method to create a deep copy of CustomObject
@NotNull String	getContainer()	A namespace to group custom objects.
@NotNull ZonedDateTime	getCreatedAt()
@Valid CreatedBy	getCreatedBy()	Present on resources created after 2019-02-01 except for events not tracked.
@NotNull String	getId()	The unique ID of this object.
@NotNull String	getKey()
@NotNull ZonedDateTime	getLastModifiedAt()
@Valid LastModifiedBy	getLastModifiedBy()	Present on resources created after 2019-02-01 except for events not tracked.
TValue	getValue()
@NotNull Long	getVersion()
static <T> GenericCustomObject<T>	of()
static <T> GenericCustomObject<T>	of(GenericCustomObject<T> template)
void	setContainer(String container)
void	setCreatedAt(ZonedDateTime createdAt)	set createdAt
void	setCreatedBy(CreatedBy createdBy)
void	setId(String id)	set id
void	setKey(String key)
void	setLastModifiedAt(ZonedDateTime lastModifiedAt)	set lastModifiedAt
void	setLastModifiedBy(LastModifiedBy lastModifiedBy)
void	setValue(TValue value)
void	setVersion(Long version)	set version
default Reference	toReference()
default <T> T	withCustomObject(Function<GenericCustomObject<TValue>,T> helper)

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

copyDeep, withBaseResource

Methods inherited from interface com.commercetools.api.models.DomainResource

get

Method Details

getId

@NotNull
@NotNull String getId()

Description copied from interface: Identifiable

The unique ID of this object.

Specified by:

getId in interface BaseResource

Specified by:

getId in interface DomainResource<TValue>

Specified by:

getId in interface Identifiable<TValue>

Specified by:

getId in interface Versioned<TValue>

Returns:

id

getVersion

@NotNull
@NotNull Long getVersion()

Specified by:

getVersion in interface BaseResource

Specified by:

getVersion in interface DomainResource<TValue>

Specified by:

getVersion in interface Versioned<TValue>

Returns:

version

getCreatedAt

@NotNull
@NotNull ZonedDateTime getCreatedAt()

Specified by:

getCreatedAt in interface BaseResource

Returns:

createdAt

getLastModifiedAt

@NotNull
@NotNull ZonedDateTime getLastModifiedAt()

Specified by:

getLastModifiedAt in interface BaseResource

Returns:

lastModifiedAt

getLastModifiedBy

@Valid
@Valid LastModifiedBy getLastModifiedBy()

Present on resources created after 2019-02-01 except for events not tracked.

Returns:

LastModifiedBy

getCreatedBy

@Valid
@Valid CreatedBy getCreatedBy()

Present on resources created after 2019-02-01 except for events not tracked.

Returns:

CreatedBy

getContainer

@NotNull
@NotNull String getContainer()

A namespace to group custom objects.

Returns:

container name

getKey

@NotNull
@NotNull String getKey()

getValue

@NotNull
TValue getValue()

setId

void setId(String id)

Description copied from interface: BaseResource

set id

Specified by:

setId in interface BaseResource

Parameters:

id - value to be set

setVersion

void setVersion(Long version)

Description copied from interface: BaseResource

set version

Specified by:

setVersion in interface BaseResource

Parameters:

version - value to be set

setCreatedAt

void setCreatedAt(ZonedDateTime createdAt)

Description copied from interface: BaseResource

set createdAt

Specified by:

setCreatedAt in interface BaseResource

Parameters:

createdAt - value to be set

setLastModifiedAt

void setLastModifiedAt(ZonedDateTime lastModifiedAt)

Description copied from interface: BaseResource

set lastModifiedAt

Specified by:

setLastModifiedAt in interface BaseResource

Parameters:

lastModifiedAt - value to be set

setLastModifiedBy

void setLastModifiedBy(LastModifiedBy lastModifiedBy)

setCreatedBy

void setCreatedBy(CreatedBy createdBy)

setContainer

void setContainer(String container)

setKey

void setKey(String key)

setValue

void setValue(TValue value)

of

static <T> GenericCustomObject<T> of()

of

static <T> GenericCustomObject<T> of(GenericCustomObject<T> template)

builder

static <T> GenericCustomObjectBuilder<T> builder(T value)

builder

static <T> GenericCustomObjectBuilder<T> builder(GenericCustomObject<T> template)

withCustomObject

default <T> T withCustomObject(Function<GenericCustomObject<TValue>,T> helper)

toReference

default Reference toReference()

Specified by:

toReference in interface Referencable<TValue>

deepCopy

@Nullable
static <TValue> GenericCustomObject<TValue> deepCopy(@Nullable
 GenericCustomObject<TValue> template)

factory method to create a deep copy of CustomObject

Parameters:

template - instance to be copied

Returns:

copy instance