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
-
Method Summary
Modifier and TypeMethodDescriptionboolean
ResourceIdentifier to a given Channel.getCode()
Error identifier."Given channel with $idOrKeyOfChannel does not have the required role $role."
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
Error-specific additional fields.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
Description copied from interface:ErrorObject
Error identifier.
- Specified by:
getCode
in interfaceErrorObject
- Specified by:
getCode
in interfaceMissingRoleOnChannelError
- Returns:
- code
-
getMessage
"Given channel with $idOrKeyOfChannel does not have the required role $role."
- Specified by:
getMessage
in interfaceErrorObject
- Specified by:
getMessage
in interfaceMissingRoleOnChannelError
- Returns:
- message
-
values
Error-specific additional fields.
- Specified by:
values
in interfaceErrorObject
- Returns:
- map of the pattern property values
-
getChannel
ResourceIdentifier to a given Channel.
- Specified by:
getChannel
in interfaceMissingRoleOnChannelError
- Returns:
- channel
-
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 interfaceMissingRoleOnChannelError
- Returns:
- missingRole
-
setMessage
Description copied from interface:MissingRoleOnChannelError
"Given channel with $idOrKeyOfChannel does not have the required role $role."
- Specified by:
setMessage
in interfaceErrorObject
- Specified by:
setMessage
in interfaceMissingRoleOnChannelError
- Parameters:
message
- value to be set
-
setValue
Description copied from interface:ErrorObject
Error-specific additional fields.
- Specified by:
setValue
in interfaceErrorObject
- Parameters:
key
- property namevalue
- property value
-
setChannel
Description copied from interface:MissingRoleOnChannelError
ResourceIdentifier to a given Channel.
- Specified by:
setChannel
in interfaceMissingRoleOnChannelError
- Parameters:
channel
- value to be set
-
setMissingRole
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 interfaceMissingRoleOnChannelError
- Parameters:
missingRole
- value to be set
-
equals
-
hashCode
-