Package com.commercetools.api.models.error

Class AssociateMissingPermissionErrorBuilder

java.lang.Object

com.commercetools.api.models.error.AssociateMissingPermissionErrorBuilder

All Implemented Interfaces:

Builder<AssociateMissingPermissionError>

public class AssociateMissingPermissionErrorBuilder
extends Object
implements Builder<AssociateMissingPermissionError>

AssociateMissingPermissionErrorBuilder Example to create an instance using the builder pattern

     AssociateMissingPermissionError associateMissingPermissionError = AssociateMissingPermissionError.builder()
             .message("{message}")
             .associate(associateBuilder -> associateBuilder)
             .businessUnit(businessUnitBuilder -> businessUnitBuilder)
             .plusPermissions(permissionsBuilder -> permissionsBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
AssociateMissingPermissionErrorBuilder()

Method Summary

Modifier and Type	Method	Description
AssociateMissingPermissionErrorBuilder	addValue(String key, Object value)	Error-specific additional fields.
AssociateMissingPermissionErrorBuilder	associate(CustomerResourceIdentifier associate)	ResourceIdentifier to the Associate that tried to perform the action.
AssociateMissingPermissionErrorBuilder	associate(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)	ResourceIdentifier to the Associate that tried to perform the action.
AssociateMissingPermissionErrorBuilder	associateOnBehalf(CustomerResourceIdentifier associateOnBehalf)	ResourceIdentifier of the Associate on whose behalf the action is performed.
AssociateMissingPermissionErrorBuilder	associateOnBehalf(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)	ResourceIdentifier of the Associate on whose behalf the action is performed.
AssociateMissingPermissionError	build()	builds AssociateMissingPermissionError with checking for non-null required values
AssociateMissingPermissionError	buildUnchecked()	builds AssociateMissingPermissionError without checking for non-null required values
AssociateMissingPermissionErrorBuilder	businessUnit(BusinessUnitResourceIdentifier businessUnit)	ResourceIdentifier to the BusinessUnit.
AssociateMissingPermissionErrorBuilder	businessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifierBuilder> builder)	ResourceIdentifier to the BusinessUnit.
CustomerResourceIdentifier	getAssociate()	ResourceIdentifier to the Associate that tried to perform the action.
CustomerResourceIdentifier	getAssociateOnBehalf()	ResourceIdentifier of the Associate on whose behalf the action is performed.
BusinessUnitResourceIdentifier	getBusinessUnit()	ResourceIdentifier to the BusinessUnit.
String	getMessage()	When an action is performed by an Associate: "Associate '$idOfAssociate' has no rights to $action in business-unit '$idOrKeyOfBusinessUnit'.

Methods inherited from class java.lang.Object

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

Constructor Details

AssociateMissingPermissionErrorBuilder

public AssociateMissingPermissionErrorBuilder()

Method Details

message

public AssociateMissingPermissionErrorBuilder message(String message)

• When an action is performed by an Associate: "Associate '$idOfAssociate' has no rights to $action in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredPermission'."
• When an action is performed for another Associate, like viewing their Cart: "Associate '$idOfAssociate' has no rights to $action for customer '$idOfCustomer' in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredPermission'."
• When viewing an entity: "Associate '$idOfAssociate' has no rights to $action in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredViewMyPermission' or '$requiredViewOthersPermission'."

Parameters:

message - value to be set

Returns:

Builder

values

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

Error-specific additional fields.

Parameters:

values - properties to be set

Returns:

Builder

addValue

public AssociateMissingPermissionErrorBuilder addValue(String key,
 Object value)

Error-specific additional fields.

Parameters:

key - property name

value - property value

Returns:

Builder

associate

public AssociateMissingPermissionErrorBuilder associate(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)

ResourceIdentifier to the Associate that tried to perform the action.

Parameters:

builder - function to build the associate value

Returns:

Builder

withAssociate

public AssociateMissingPermissionErrorBuilder withAssociate(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)

ResourceIdentifier to the Associate that tried to perform the action.

Parameters:

builder - function to build the associate value

Returns:

Builder

associate

public AssociateMissingPermissionErrorBuilder associate(CustomerResourceIdentifier associate)

ResourceIdentifier to the Associate that tried to perform the action.

Parameters:

associate - value to be set

Returns:

Builder

businessUnit

public AssociateMissingPermissionErrorBuilder businessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifierBuilder> builder)

ResourceIdentifier to the BusinessUnit.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

withBusinessUnit

public AssociateMissingPermissionErrorBuilder withBusinessUnit(Function<BusinessUnitResourceIdentifierBuilder,BusinessUnitResourceIdentifier> builder)

ResourceIdentifier to the BusinessUnit.

Parameters:

builder - function to build the businessUnit value

Returns:

Builder

businessUnit

public AssociateMissingPermissionErrorBuilder businessUnit(BusinessUnitResourceIdentifier businessUnit)

ResourceIdentifier to the BusinessUnit.

Parameters:

businessUnit - value to be set

Returns:

Builder

associateOnBehalf

public AssociateMissingPermissionErrorBuilder associateOnBehalf(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifierBuilder> builder)

ResourceIdentifier of the Associate on whose behalf the action is performed.

Parameters:

builder - function to build the associateOnBehalf value

Returns:

Builder

withAssociateOnBehalf

public AssociateMissingPermissionErrorBuilder withAssociateOnBehalf(Function<CustomerResourceIdentifierBuilder,CustomerResourceIdentifier> builder)

ResourceIdentifier of the Associate on whose behalf the action is performed.

Parameters:

builder - function to build the associateOnBehalf value

Returns:

Builder

associateOnBehalf

public AssociateMissingPermissionErrorBuilder associateOnBehalf(@Nullable
 CustomerResourceIdentifier associateOnBehalf)

ResourceIdentifier of the Associate on whose behalf the action is performed.

Parameters:

associateOnBehalf - value to be set

Returns:

Builder

permissions

public AssociateMissingPermissionErrorBuilder permissions(Permission... permissions)

The Permissions that the Associate performing the action lacks. At least one of these Permissions is needed.

Parameters:

permissions - value to be set

Returns:

Builder

permissions

public AssociateMissingPermissionErrorBuilder permissions(List<Permission> permissions)

The Permissions that the Associate performing the action lacks. At least one of these Permissions is needed.

Parameters:

permissions - value to be set

Returns:

Builder

plusPermissions

public AssociateMissingPermissionErrorBuilder plusPermissions(Permission... permissions)

The Permissions that the Associate performing the action lacks. At least one of these Permissions is needed.

Parameters:

permissions - value to be set

Returns:

Builder

getMessage

public String getMessage()

• When an action is performed by an Associate: "Associate '$idOfAssociate' has no rights to $action in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredPermission'."
• When an action is performed for another Associate, like viewing their Cart: "Associate '$idOfAssociate' has no rights to $action for customer '$idOfCustomer' in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredPermission'."
• When viewing an entity: "Associate '$idOfAssociate' has no rights to $action in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredViewMyPermission' or '$requiredViewOthersPermission'."

Returns:

message

getValues

public Map<String,Object> getValues()

Error-specific additional fields.

Returns:

pattern properties

getAssociate

public CustomerResourceIdentifier getAssociate()

ResourceIdentifier to the Associate that tried to perform the action.

Returns:

associate

getBusinessUnit

public BusinessUnitResourceIdentifier getBusinessUnit()

ResourceIdentifier to the BusinessUnit.

Returns:

businessUnit

getAssociateOnBehalf

@Nullable
public CustomerResourceIdentifier getAssociateOnBehalf()

ResourceIdentifier of the Associate on whose behalf the action is performed.

Returns:

associateOnBehalf

getPermissions

public List<Permission> getPermissions()

The Permissions that the Associate performing the action lacks. At least one of these Permissions is needed.

Returns:

permissions

build

public AssociateMissingPermissionError build()

builds AssociateMissingPermissionError with checking for non-null required values

Specified by:

build in interface Builder<AssociateMissingPermissionError>

Returns:

AssociateMissingPermissionError

buildUnchecked

public AssociateMissingPermissionError buildUnchecked()

builds AssociateMissingPermissionError without checking for non-null required values

Returns:

AssociateMissingPermissionError

of

public static AssociateMissingPermissionErrorBuilder of()

factory method for an instance of AssociateMissingPermissionErrorBuilder

Returns:

builder

of

public static AssociateMissingPermissionErrorBuilder of(AssociateMissingPermissionError template)

create builder for AssociateMissingPermissionError instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder