Package com.commercetools.api.models.error

Class MissingRoleOnChannelErrorBuilder

java.lang.Object

com.commercetools.api.models.error.MissingRoleOnChannelErrorBuilder

All Implemented Interfaces:

Builder<MissingRoleOnChannelError>

public class MissingRoleOnChannelErrorBuilder
extends Object
implements Builder<MissingRoleOnChannelError>

MissingRoleOnChannelErrorBuilder Example to create an instance using the builder pattern

     MissingRoleOnChannelError missingRoleOnChannelError = MissingRoleOnChannelError.builder()
             .message("{message}")
             .missingRole(ChannelRoleEnum.INVENTORY_SUPPLY)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
MissingRoleOnChannelErrorBuilder()

Method Summary

Modifier and Type	Method	Description
MissingRoleOnChannelErrorBuilder	addValue(String key, Object value)	Error-specific additional fields.
MissingRoleOnChannelError	build()	builds MissingRoleOnChannelError with checking for non-null required values
MissingRoleOnChannelError	buildUnchecked()	builds MissingRoleOnChannelError without checking for non-null required values
MissingRoleOnChannelErrorBuilder	channel(ChannelResourceIdentifier channel)	ResourceIdentifier to a given Channel.
MissingRoleOnChannelErrorBuilder	channel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)	ResourceIdentifier to a given Channel.
ChannelResourceIdentifier	getChannel()	ResourceIdentifier to a given Channel.
String	getMessage()	"Given channel with $idOrKeyOfChannel does not have the required role $role."
ChannelRoleEnum	getMissingRole()	ProductDistribution for Product Distribution Channels allowed for the Store.
Map<String,Object>	getValues()	Error-specific additional fields.
MissingRoleOnChannelErrorBuilder	message(String message)	"Given channel with $idOrKeyOfChannel does not have the required role $role."
MissingRoleOnChannelErrorBuilder	missingRole(ChannelRoleEnum missingRole)	ProductDistribution for Product Distribution Channels allowed for the Store.
static MissingRoleOnChannelErrorBuilder	of()	factory method for an instance of MissingRoleOnChannelErrorBuilder
static MissingRoleOnChannelErrorBuilder	of(MissingRoleOnChannelError template)	create builder for MissingRoleOnChannelError instance
MissingRoleOnChannelErrorBuilder	values(Map<String,Object> values)	Error-specific additional fields.
MissingRoleOnChannelErrorBuilder	withChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)	ResourceIdentifier to a given Channel.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MissingRoleOnChannelErrorBuilder

public MissingRoleOnChannelErrorBuilder()

Method Details

message

public MissingRoleOnChannelErrorBuilder message(String message)

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

Parameters:

message - value to be set

Returns:

Builder

values

public MissingRoleOnChannelErrorBuilder values(Map<String,Object> values)

Error-specific additional fields.

Parameters:

values - properties to be set

Returns:

Builder

addValue

public MissingRoleOnChannelErrorBuilder addValue(String key,
 Object value)

Error-specific additional fields.

Parameters:

key - property name

value - property value

Returns:

Builder

channel

public MissingRoleOnChannelErrorBuilder channel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifierBuilder> builder)

ResourceIdentifier to a given Channel.

Parameters:

builder - function to build the channel value

Returns:

Builder

withChannel

public MissingRoleOnChannelErrorBuilder withChannel(Function<ChannelResourceIdentifierBuilder,ChannelResourceIdentifier> builder)

ResourceIdentifier to a given Channel.

Parameters:

builder - function to build the channel value

Returns:

Builder

channel

public MissingRoleOnChannelErrorBuilder channel(@Nullable
 ChannelResourceIdentifier channel)

ResourceIdentifier to a given Channel.

Parameters:

channel - value to be set

Returns:

Builder

missingRole

public MissingRoleOnChannelErrorBuilder missingRole(ChannelRoleEnum missingRole)

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

Parameters:

missingRole - value to be set

Returns:

Builder

getMessage

public String getMessage()

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

Returns:

message

getValues

public Map<String,Object> getValues()

Error-specific additional fields.

Returns:

pattern properties

getChannel

@Nullable
public ChannelResourceIdentifier getChannel()

ResourceIdentifier to a given Channel.

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.

Returns:

missingRole

build

public MissingRoleOnChannelError build()

builds MissingRoleOnChannelError with checking for non-null required values

Specified by:

build in interface Builder<MissingRoleOnChannelError>

Returns:

MissingRoleOnChannelError

buildUnchecked

public MissingRoleOnChannelError buildUnchecked()

builds MissingRoleOnChannelError without checking for non-null required values

Returns:

MissingRoleOnChannelError

of

public static MissingRoleOnChannelErrorBuilder of()

factory method for an instance of MissingRoleOnChannelErrorBuilder

Returns:

builder

of

public static MissingRoleOnChannelErrorBuilder of(MissingRoleOnChannelError template)

create builder for MissingRoleOnChannelError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder