Package com.commercetools.api.models.error

Class MissingRoleOnChannelErrorImpl

java.lang.Object

com.commercetools.api.models.error.MissingRoleOnChannelErrorImpl

All Implemented Interfaces:

ErrorObject, MissingRoleOnChannelError, io.vrap.rmf.base.client.ModelBase

public class MissingRoleOnChannelErrorImpl
extends Object
implements MissingRoleOnChannelError, io.vrap.rmf.base.client.ModelBase

Returned when one of the following states occur:

• Channel is added or set on a Store with missing Channel roles.
• Standalone Price references a Channel that does not contain the ProductDistribution role.

The error is returned as a failed response to:

• Add Distribution Channel, Set Distribution Channel, Add Supply Channel, and Set Supply Channel update actions.
• Create a Standalone Price request.

Nested Class Summary

Nested classes/interfaces inherited from interface io.vrap.rmf.base.client.ModelBase

io.vrap.rmf.base.client.ModelBase.FilteredRecursiveToStringStyle

Field Summary

Fields inherited from interface com.commercetools.api.models.error.MissingRoleOnChannelError

MISSING_ROLE_ON_CHANNEL

Constructor Summary

Constructors

Constructor	Description
MissingRoleOnChannelErrorImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
ChannelResourceIdentifier	getChannel()	ResourceIdentifier to a given Channel.
String	getCode()	Error identifier.
String	getMessage()	"Given channel with $idOrKeyOfChannel does not have the required role $role."
ChannelRoleEnum	getMissingRole()	ProductDistribution for Product Distribution Channels allowed for the Store.
int	hashCode()
void	setChannel(ChannelResourceIdentifier channel)	ResourceIdentifier to a given Channel.
void	setMessage(String message)	"Given channel with $idOrKeyOfChannel does not have the required role $role."
void	setMissingRole(ChannelRoleEnum missingRole)	ProductDistribution for Product Distribution Channels allowed for the Store.
void	setValue(String key, Object value)	Error-specific additional fields.
Map<String,Object>	values()	Error-specific additional fields.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.commercetools.api.models.error.ErrorObject

withErrorObject

Methods inherited from interface com.commercetools.api.models.error.MissingRoleOnChannelError

withMissingRoleOnChannelError

Methods inherited from interface io.vrap.rmf.base.client.ModelBase

reflectionString, reflectionString

Constructor Details

MissingRoleOnChannelErrorImpl

public MissingRoleOnChannelErrorImpl()

create empty instance

Method Details

getCode

public String getCode()

Description copied from interface: ErrorObject

Error identifier.

Specified by:

getCode in interface ErrorObject

Specified by:

getCode in interface MissingRoleOnChannelError

Returns:

code

getMessage

public String getMessage()

"Given channel with $idOrKeyOfChannel does not have the required role $role."

Specified by:

getMessage in interface ErrorObject

Specified by:

getMessage in interface MissingRoleOnChannelError

Returns:

message

values

public Map<String,Object> values()

Error-specific additional fields.

Specified by:

values in interface ErrorObject

Returns:

map of the pattern property values

getChannel

public ChannelResourceIdentifier getChannel()

ResourceIdentifier to a given Channel.

Specified by:

getChannel in interface MissingRoleOnChannelError

Returns:

channel

getMissingRole

public ChannelRoleEnum getMissingRole()

• ProductDistribution for Product Distribution Channels allowed for the Store. Also required for Standalone Prices.
• InventorySupply for Inventory Supply Channels allowed for the Store.

Specified by:

getMissingRole in interface MissingRoleOnChannelError

Returns:

missingRole

setMessage

public void setMessage(String message)

Description copied from interface: MissingRoleOnChannelError

"Given channel with $idOrKeyOfChannel does not have the required role $role."

Specified by:

setMessage in interface ErrorObject

Specified by:

setMessage in interface MissingRoleOnChannelError

Parameters:

message - value to be set

setValue

public void setValue(String key,
 Object value)

Description copied from interface: ErrorObject

Error-specific additional fields.

Specified by:

setValue in interface ErrorObject

Parameters:

key - property name

value - property value

setChannel

public void setChannel(ChannelResourceIdentifier channel)

Description copied from interface: MissingRoleOnChannelError

ResourceIdentifier to a given Channel.

Specified by:

setChannel in interface MissingRoleOnChannelError

Parameters:

channel - value to be set

setMissingRole

public void setMissingRole(ChannelRoleEnum missingRole)

Description copied from interface: MissingRoleOnChannelError

• ProductDistribution for Product Distribution Channels allowed for the Store. Also required for Standalone Prices.
• InventorySupply for Inventory Supply Channels allowed for the Store.

Specified by:

setMissingRole in interface MissingRoleOnChannelError

Parameters:

missingRole - value to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object