Package com.commercetools.api.models.error

Class AssociateMissingPermissionErrorImpl

java.lang.Object

com.commercetools.api.models.error.AssociateMissingPermissionErrorImpl

All Implemented Interfaces:

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

public class AssociateMissingPermissionErrorImpl
extends Object
implements AssociateMissingPermissionError, io.vrap.rmf.base.client.ModelBase

Returned when an Associate is missing a Permission on a B2B resource.

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.AssociateMissingPermissionError

ASSOCIATE_MISSING_PERMISSION

Constructor Summary

Constructors

Constructor	Description
AssociateMissingPermissionErrorImpl()	create empty instance

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
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	getCode()	Error identifier.
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

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

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

withAssociateMissingPermissionError

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

withErrorObject

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

reflectionString, reflectionString

Constructor Details

AssociateMissingPermissionErrorImpl

public AssociateMissingPermissionErrorImpl()

create empty instance

Method Details

getCode

public String getCode()

Description copied from interface: ErrorObject

Error identifier.

Specified by:

getCode in interface AssociateMissingPermissionError

Specified by:

getCode in interface ErrorObject

Returns:

code

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'."

Specified by:

getMessage in interface AssociateMissingPermissionError

Specified by:

getMessage in interface ErrorObject

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

getAssociate

public CustomerResourceIdentifier getAssociate()

ResourceIdentifier to the Associate that tried to perform the action.

Specified by:

getAssociate in interface AssociateMissingPermissionError

Returns:

associate

getBusinessUnit

public BusinessUnitResourceIdentifier getBusinessUnit()

ResourceIdentifier to the BusinessUnit.

Specified by:

getBusinessUnit in interface AssociateMissingPermissionError

Returns:

businessUnit

getAssociateOnBehalf

public CustomerResourceIdentifier getAssociateOnBehalf()

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

Specified by:

getAssociateOnBehalf in interface AssociateMissingPermissionError

Returns:

associateOnBehalf

getPermissions

public List<Permission> getPermissions()

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

Specified by:

getPermissions in interface AssociateMissingPermissionError

Returns:

permissions

setMessage

public void setMessage(String message)

Description copied from interface: AssociateMissingPermissionError

• 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'."

Specified by:

setMessage in interface AssociateMissingPermissionError

Specified by:

setMessage in interface ErrorObject

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

setAssociate

public void setAssociate(CustomerResourceIdentifier associate)

Description copied from interface: AssociateMissingPermissionError

ResourceIdentifier to the Associate that tried to perform the action.

Specified by:

setAssociate in interface AssociateMissingPermissionError

Parameters:

associate - value to be set

setBusinessUnit

public void setBusinessUnit(BusinessUnitResourceIdentifier businessUnit)

Description copied from interface: AssociateMissingPermissionError

ResourceIdentifier to the BusinessUnit.

Specified by:

setBusinessUnit in interface AssociateMissingPermissionError

Parameters:

businessUnit - value to be set

setAssociateOnBehalf

public void setAssociateOnBehalf(CustomerResourceIdentifier associateOnBehalf)

Description copied from interface: AssociateMissingPermissionError

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

Specified by:

setAssociateOnBehalf in interface AssociateMissingPermissionError

Parameters:

associateOnBehalf - value to be set

setPermissions

public void setPermissions(Permission... permissions)

Description copied from interface: AssociateMissingPermissionError

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

Specified by:

setPermissions in interface AssociateMissingPermissionError

Parameters:

permissions - values to be set

setPermissions

public void setPermissions(List<Permission> permissions)

Description copied from interface: AssociateMissingPermissionError

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

Specified by:

setPermissions in interface AssociateMissingPermissionError

Parameters:

permissions - values to be set

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object