Package com.commercetools.api.models.approval_rule

Class ApprovalRuleDraftBuilder

java.lang.Object

com.commercetools.api.models.approval_rule.ApprovalRuleDraftBuilder

All Implemented Interfaces:

Builder<ApprovalRuleDraft>

public class ApprovalRuleDraftBuilder
extends Object
implements Builder<ApprovalRuleDraft>

ApprovalRuleDraftBuilder Example to create an instance using the builder pattern

     ApprovalRuleDraft approvalRuleDraft = ApprovalRuleDraft.builder()
             .name("{name}")
             .status(ApprovalRuleStatus.ACTIVE)
             .predicate("{predicate}")
             .approvers(approversBuilder -> approversBuilder)
             .plusRequesters(requestersBuilder -> requestersBuilder)
             .build()
 

Constructor Summary

Constructors

Constructor	Description
ApprovalRuleDraftBuilder()

Method Summary

Modifier and Type	Method	Description
ApprovalRuleDraftBuilder	addRequesters(Function<RuleRequesterDraftBuilder,RuleRequesterDraft> builder)	The Associate Roles customers must hold for their Order to require approval.
ApprovalRuleDraftBuilder	approvers(ApproverHierarchyDraft approvers)	The hierarchy of approvers within the Approval Rule.
ApprovalRuleDraftBuilder	approvers(Function<ApproverHierarchyDraftBuilder,ApproverHierarchyDraftBuilder> builder)	The hierarchy of approvers within the Approval Rule.
ApprovalRuleDraft	build()	builds ApprovalRuleDraft with checking for non-null required values
ApprovalRuleDraft	buildUnchecked()	builds ApprovalRuleDraft without checking for non-null required values
ApprovalRuleDraftBuilder	description(String description)	Description of the Approval Rule.
ApproverHierarchyDraft	getApprovers()	The hierarchy of approvers within the Approval Rule.
String	getDescription()	Description of the Approval Rule.
String	getKey()	User-defined unique identifier of the Approval Rule.
String	getName()	Name of the Approval Rule.
String	getPredicate()	The predicate describing the Orders the Approval Rule should match against.
List<RuleRequesterDraft>	getRequesters()	The Associate Roles customers must hold for their Order to require approval.
ApprovalRuleStatus	getStatus()	Indicates whether the Approval Rule should be matched against Orders or not.
ApprovalRuleDraftBuilder	key(String key)	User-defined unique identifier of the Approval Rule.
ApprovalRuleDraftBuilder	name(String name)	Name of the Approval Rule.
static ApprovalRuleDraftBuilder	of()	factory method for an instance of ApprovalRuleDraftBuilder
static ApprovalRuleDraftBuilder	of(ApprovalRuleDraft template)	create builder for ApprovalRuleDraft instance
ApprovalRuleDraftBuilder	plusRequesters(RuleRequesterDraft... requesters)	The Associate Roles customers must hold for their Order to require approval.
ApprovalRuleDraftBuilder	plusRequesters(Function<RuleRequesterDraftBuilder,RuleRequesterDraftBuilder> builder)	The Associate Roles customers must hold for their Order to require approval.
ApprovalRuleDraftBuilder	predicate(String predicate)	The predicate describing the Orders the Approval Rule should match against.
ApprovalRuleDraftBuilder	requesters(RuleRequesterDraft... requesters)	The Associate Roles customers must hold for their Order to require approval.
ApprovalRuleDraftBuilder	requesters(List<RuleRequesterDraft> requesters)	The Associate Roles customers must hold for their Order to require approval.
ApprovalRuleDraftBuilder	setRequesters(Function<RuleRequesterDraftBuilder,RuleRequesterDraft> builder)	The Associate Roles customers must hold for their Order to require approval.
ApprovalRuleDraftBuilder	status(ApprovalRuleStatus status)	Indicates whether the Approval Rule should be matched against Orders or not.
ApprovalRuleDraftBuilder	withApprovers(Function<ApproverHierarchyDraftBuilder,ApproverHierarchyDraft> builder)	The hierarchy of approvers within the Approval Rule.
ApprovalRuleDraftBuilder	withRequesters(Function<RuleRequesterDraftBuilder,RuleRequesterDraftBuilder> builder)	The Associate Roles customers must hold for their Order to require approval.

Methods inherited from class java.lang.Object

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

Constructor Details

ApprovalRuleDraftBuilder

public ApprovalRuleDraftBuilder()

Method Details

key

public ApprovalRuleDraftBuilder key(@Nullable
 String key)

User-defined unique identifier of the Approval Rule. Uniqueness is enforced within the Business Unit.

Parameters:

key - value to be set

Returns:

Builder

name

public ApprovalRuleDraftBuilder name(String name)

Name of the Approval Rule.

Parameters:

name - value to be set

Returns:

Builder

description

public ApprovalRuleDraftBuilder description(@Nullable
 String description)

Description of the Approval Rule.

Parameters:

description - value to be set

Returns:

Builder

status

public ApprovalRuleDraftBuilder status(ApprovalRuleStatus status)

Indicates whether the Approval Rule should be matched against Orders or not.

Parameters:

status - value to be set

Returns:

Builder

predicate

public ApprovalRuleDraftBuilder predicate(String predicate)

The predicate describing the Orders the Approval Rule should match against.

Parameters:

predicate - value to be set

Returns:

Builder

approvers

public ApprovalRuleDraftBuilder approvers(Function<ApproverHierarchyDraftBuilder,ApproverHierarchyDraftBuilder> builder)

The hierarchy of approvers within the Approval Rule.

Parameters:

builder - function to build the approvers value

Returns:

Builder

withApprovers

public ApprovalRuleDraftBuilder withApprovers(Function<ApproverHierarchyDraftBuilder,ApproverHierarchyDraft> builder)

The hierarchy of approvers within the Approval Rule.

Parameters:

builder - function to build the approvers value

Returns:

Builder

approvers

public ApprovalRuleDraftBuilder approvers(ApproverHierarchyDraft approvers)

The hierarchy of approvers within the Approval Rule.

Parameters:

approvers - value to be set

Returns:

Builder

requesters

public ApprovalRuleDraftBuilder requesters(RuleRequesterDraft... requesters)

The Associate Roles customers must hold for their Order to require approval.

Parameters:

requesters - value to be set

Returns:

Builder

requesters

public ApprovalRuleDraftBuilder requesters(List<RuleRequesterDraft> requesters)

The Associate Roles customers must hold for their Order to require approval.

Parameters:

requesters - value to be set

Returns:

Builder

plusRequesters

public ApprovalRuleDraftBuilder plusRequesters(RuleRequesterDraft... requesters)

The Associate Roles customers must hold for their Order to require approval.

Parameters:

requesters - value to be set

Returns:

Builder

plusRequesters

public ApprovalRuleDraftBuilder plusRequesters(Function<RuleRequesterDraftBuilder,RuleRequesterDraftBuilder> builder)

The Associate Roles customers must hold for their Order to require approval.

Parameters:

builder - function to build the requesters value

Returns:

Builder

withRequesters

public ApprovalRuleDraftBuilder withRequesters(Function<RuleRequesterDraftBuilder,RuleRequesterDraftBuilder> builder)

The Associate Roles customers must hold for their Order to require approval.

Parameters:

builder - function to build the requesters value

Returns:

Builder

addRequesters

public ApprovalRuleDraftBuilder addRequesters(Function<RuleRequesterDraftBuilder,RuleRequesterDraft> builder)

The Associate Roles customers must hold for their Order to require approval.

Parameters:

builder - function to build the requesters value

Returns:

Builder

setRequesters

public ApprovalRuleDraftBuilder setRequesters(Function<RuleRequesterDraftBuilder,RuleRequesterDraft> builder)

The Associate Roles customers must hold for their Order to require approval.

Parameters:

builder - function to build the requesters value

Returns:

Builder

getKey

@Nullable
public String getKey()

User-defined unique identifier of the Approval Rule. Uniqueness is enforced within the Business Unit.

Returns:

key

getName

public String getName()

Name of the Approval Rule.

Returns:

name

getDescription

@Nullable
public String getDescription()

Description of the Approval Rule.

Returns:

description

getStatus

public ApprovalRuleStatus getStatus()

Indicates whether the Approval Rule should be matched against Orders or not.

Returns:

status

getPredicate

public String getPredicate()

The predicate describing the Orders the Approval Rule should match against.

Returns:

predicate

getApprovers

public ApproverHierarchyDraft getApprovers()

The hierarchy of approvers within the Approval Rule.

Returns:

approvers

getRequesters

public List<RuleRequesterDraft> getRequesters()

The Associate Roles customers must hold for their Order to require approval.

Returns:

requesters

build

public ApprovalRuleDraft build()

builds ApprovalRuleDraft with checking for non-null required values

Specified by:

build in interface Builder<ApprovalRuleDraft>

Returns:

ApprovalRuleDraft

buildUnchecked

public ApprovalRuleDraft buildUnchecked()

builds ApprovalRuleDraft without checking for non-null required values

Returns:

ApprovalRuleDraft

of

public static ApprovalRuleDraftBuilder of()

factory method for an instance of ApprovalRuleDraftBuilder

Returns:

builder

of

public static ApprovalRuleDraftBuilder of(ApprovalRuleDraft template)

create builder for ApprovalRuleDraft instance

Parameters:

template - instance with prefilled values for the builder

Returns:

builder