io.sphere.sdk.channels

Interface Channel

All Superinterfaces:

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

public interface Channel
extends Resource<Channel>, WithKey, Custom

Channels represent a source or destination of different entities.

A Customer can have custom fields.

See Also:

ChannelCreateCommand, ChannelUpdateCommand, ChannelDeleteCommand, ChannelQuery, ChannelByIdGet, LineItem.getSupplyChannel(), InventoryEntry.getSupplyChannel(), SyncInfo.getChannel(), Price.getChannel(), Review.getTarget()

Method Summary

Modifier and Type	Method and Description
Address	getAddress() The address of a channel.
CustomFields	getCustom()
LocalizedString	getDescription() Description of this channel.
GeoJSON	getGeoLocation() Returns the geo location of this channel.
String	getKey() Any arbitrary string key that unique identifies this channel within the project.
LocalizedString	getName() Name of this channel.
ReviewRatingStatistics	getReviewRatingStatistics() The Review ratings of this channel.
Set<ChannelRole>	getRoles() The roles of this channel.
static Reference<Channel>	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() An identifier for this resource which supports CustomFields.
default Reference<Channel>	toReference() Creates a reference to this resource, the reference may not be filled.
static com.fasterxml.jackson.core.type.TypeReference<Channel>	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()

Any arbitrary string key that unique identifies this channel within the project.

Specified by:

getKey in interface WithKey

Returns:

key

See Also:

ChangeKey

getRoles

@Nonnull
Set<ChannelRole> getRoles()

The roles of this channel. Each channel must have at least one role.

Returns:

roles

See Also:

SetRoles, AddRoles, RemoveRoles

getName

@Nullable
LocalizedString getName()

Name of this channel.

Returns:

name

See Also:

ChangeName

getDescription

@Nullable
LocalizedString getDescription()

Description of this channel.

Returns:

description

See Also:

ChangeDescription

getReviewRatingStatistics

@Nullable
ReviewRatingStatistics getReviewRatingStatistics()

The Review ratings of this channel.

Returns:

ratings or null

See Also:

Review, ReviewDraft.getTarget()

toReference

default Reference<Channel> toReference()

Description copied from interface: Referenceable

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

Specified by:

toReference in interface Referenceable<Channel>

Specified by:

toReference in interface Resource<Channel>

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()

typeReference

static com.fasterxml.jackson.core.type.TypeReference<Channel> 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<Channel> 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

resourceTypeId

static String resourceTypeId()

An identifier for this resource which supports CustomFields.

Returns:

ID of this resource type

See Also:

TypeDraft.getResourceTypeIds(), Custom

getCustom

@Nullable
CustomFields getCustom()

Specified by:

getCustom in interface Custom

getAddress

@Nullable
Address getAddress()

The address of a channel.

Returns:

null or address

See Also:

SetAddress

getGeoLocation

@Nullable
GeoJSON getGeoLocation()

Returns the geo location of this channel.

Returns:

the geo location of this channel or null