Package com.commercetools.api.models.project

Interface BusinessUnitConfiguration

All Known Implementing Classes:

BusinessUnitConfigurationImpl

public interface BusinessUnitConfiguration

BusinessUnitConfiguration Example to create an instance using the builder pattern

     BusinessUnitConfiguration businessUnitConfiguration = BusinessUnitConfiguration.builder()
             .myBusinessUnitStatusOnCreation(BusinessUnitConfigurationStatus.ACTIVE)
             .build()
 

Method Summary

Modifier and Type	Method	Description
static BusinessUnitConfigurationBuilder	builder()	builder factory method for BusinessUnitConfiguration
static BusinessUnitConfigurationBuilder	builder(BusinessUnitConfiguration template)	create builder for BusinessUnitConfiguration instance
static BusinessUnitConfiguration	deepCopy(BusinessUnitConfiguration template)	factory method to create a deep copy of BusinessUnitConfiguration
@Valid AssociateRoleKeyReference	getMyBusinessUnitAssociateRoleOnCreation()	Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint.
@NotNull BusinessUnitConfigurationStatus	getMyBusinessUnitStatusOnCreation()	Status of Business Units created using the My Business Unit endpoint.
static BusinessUnitConfiguration	of()	factory method
static BusinessUnitConfiguration	of(BusinessUnitConfiguration template)	factory method to create a shallow copy BusinessUnitConfiguration
void	setMyBusinessUnitAssociateRoleOnCreation(AssociateRoleKeyReference myBusinessUnitAssociateRoleOnCreation)	Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint.
void	setMyBusinessUnitStatusOnCreation(BusinessUnitConfigurationStatus myBusinessUnitStatusOnCreation)	Status of Business Units created using the My Business Unit endpoint.
static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitConfiguration>	typeReference()	gives a TypeReference for usage with Jackson DataBind
default <T> T	withBusinessUnitConfiguration(Function<BusinessUnitConfiguration,T> helper)	accessor map function

Method Details

getMyBusinessUnitStatusOnCreation

@NotNull
@NotNull BusinessUnitConfigurationStatus getMyBusinessUnitStatusOnCreation()

Status of Business Units created using the My Business Unit endpoint.

Returns:

myBusinessUnitStatusOnCreation

getMyBusinessUnitAssociateRoleOnCreation

@Valid
@Valid AssociateRoleKeyReference getMyBusinessUnitAssociateRoleOnCreation()

Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint.

Returns:

myBusinessUnitAssociateRoleOnCreation

setMyBusinessUnitStatusOnCreation

void setMyBusinessUnitStatusOnCreation(BusinessUnitConfigurationStatus myBusinessUnitStatusOnCreation)

Status of Business Units created using the My Business Unit endpoint.

Parameters:

myBusinessUnitStatusOnCreation - value to be set

setMyBusinessUnitAssociateRoleOnCreation

void setMyBusinessUnitAssociateRoleOnCreation(AssociateRoleKeyReference myBusinessUnitAssociateRoleOnCreation)

Default Associate Role assigned to the Associate creating a Business Unit using the My Business Unit endpoint.

Parameters:

myBusinessUnitAssociateRoleOnCreation - value to be set

of

static BusinessUnitConfiguration of()

factory method

Returns:

instance of BusinessUnitConfiguration

of

static BusinessUnitConfiguration of(BusinessUnitConfiguration template)

factory method to create a shallow copy BusinessUnitConfiguration

Parameters:

template - instance to be copied

Returns:

copy instance

deepCopy

@Nullable
static BusinessUnitConfiguration deepCopy(@Nullable
 BusinessUnitConfiguration template)

factory method to create a deep copy of BusinessUnitConfiguration

Parameters:

template - instance to be copied

Returns:

copy instance

builder

static BusinessUnitConfigurationBuilder builder()

builder factory method for BusinessUnitConfiguration

Returns:

builder

builder

static BusinessUnitConfigurationBuilder builder(BusinessUnitConfiguration template)

create builder for BusinessUnitConfiguration instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder

withBusinessUnitConfiguration

default <T> T withBusinessUnitConfiguration(Function<BusinessUnitConfiguration,T> helper)

accessor map function

Type Parameters:

T - mapped type

Parameters:

helper - function to map the object

Returns:

mapped value

typeReference

static com.fasterxml.jackson.core.type.TypeReference<BusinessUnitConfiguration> typeReference()

gives a TypeReference for usage with Jackson DataBind

Returns:

TypeReference