com.commercetools.api.models.zone

Interface Zone

All Superinterfaces:

BaseResource, DomainResource<Zone>

All Known Implementing Classes:

ZoneImpl

public interface Zone
extends BaseResource, DomainResource<Zone>

Method Summary

Modifier and Type	Method and Description
static ZoneBuilder	builder()
static ZoneBuilder	builder(Zone template)
@NotNull ZonedDateTime	getCreatedAt()
@Valid CreatedBy	getCreatedBy()
String	getDescription()
@NotNull String	getId() The unique ID of the zone.
String	getKey() User-specific unique identifier for a zone.
@NotNull ZonedDateTime	getLastModifiedAt()
@Valid LastModifiedBy	getLastModifiedBy()
@NotNull @Valid List<Location>	getLocations()
@NotNull String	getName()
@NotNull Long	getVersion() The current version of the zone.
static Zone	of()
static Zone	of(Zone template)
void	setCreatedAt(ZonedDateTime createdAt)
void	setCreatedBy(CreatedBy createdBy)
void	setDescription(String description)
void	setId(String id)
void	setKey(String key)
void	setLastModifiedAt(ZonedDateTime lastModifiedAt)
void	setLastModifiedBy(LastModifiedBy lastModifiedBy)
void	setLocations(List<Location> locations)
void	setLocations(Location... locations)
void	setName(String name)
void	setVersion(Long version)
default <T> T	withZone(Function<Zone,T> helper)

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

withBaseResource

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

get

Method Detail

getId

@NotNull
@NotNull String getId()

The unique ID of the zone.

Specified by:

getId in interface BaseResource

Specified by:

getId in interface DomainResource<Zone>

getVersion

@NotNull
@NotNull Long getVersion()

The current version of the zone.

Specified by:

getVersion in interface BaseResource

Specified by:

getVersion in interface DomainResource<Zone>

getCreatedAt

@NotNull
@NotNull ZonedDateTime getCreatedAt()

Specified by:

getCreatedAt in interface BaseResource

getLastModifiedAt

@NotNull
@NotNull ZonedDateTime getLastModifiedAt()

Specified by:

getLastModifiedAt in interface BaseResource

getLastModifiedBy

@Valid
@Valid LastModifiedBy getLastModifiedBy()

getCreatedBy

@Valid
@Valid CreatedBy getCreatedBy()

getKey

String getKey()

User-specific unique identifier for a zone. Must be unique across a project. The field can be reset using the Set Key UpdateAction.

getName

@NotNull
@NotNull String getName()

getDescription

String getDescription()

getLocations

@NotNull
 @Valid
@NotNull @Valid List<Location> getLocations()

setId

void setId(String id)

Specified by:

setId in interface BaseResource

setVersion

void setVersion(Long version)

Specified by:

setVersion in interface BaseResource

setCreatedAt

void setCreatedAt(ZonedDateTime createdAt)

Specified by:

setCreatedAt in interface BaseResource

setLastModifiedAt

void setLastModifiedAt(ZonedDateTime lastModifiedAt)

Specified by:

setLastModifiedAt in interface BaseResource

setLastModifiedBy

void setLastModifiedBy(LastModifiedBy lastModifiedBy)

setCreatedBy

void setCreatedBy(CreatedBy createdBy)

setKey

void setKey(String key)

setName

void setName(String name)

setDescription

void setDescription(String description)

setLocations

void setLocations(Location... locations)

setLocations

void setLocations(List<Location> locations)

of

static Zone of()

of

static Zone of(Zone template)

builder

static ZoneBuilder builder()

builder

static ZoneBuilder builder(Zone template)

withZone

default <T> T withZone(Function<Zone,T> helper)