Class OrderFromQuoteDraftBuilder
- All Implemented Interfaces:
io.vrap.rmf.base.client.Builder<OrderFromQuoteDraft>
Example to create an instance using the builder pattern
OrderFromQuoteDraft orderFromQuoteDraft = OrderFromQuoteDraft.builder()
.quote(quoteBuilder -> quoteBuilder)
.version(0.3)
.build()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
builds OrderFromQuoteDraft with checking for non-null required valuesbuilds OrderFromQuoteDraft without checking for non-null required valuesString that uniquely identifies an order.Order will be created withOpen
status by default.Payment state of the Order.getQuote()
ResourceIdentifier of the Quote from which this Order is created.Iftrue
, thequoteState
of the referenced Quote will be set toAccepted
.Shipment state of the Order.getState()
Reference to a State indicating the Order's state.version
of the Quote from which an Order is created.static OrderFromQuoteDraftBuilder
of()
factory method for an instance of OrderFromQuoteDraftBuilderstatic OrderFromQuoteDraftBuilder
of
(OrderFromQuoteDraft template) create builder for OrderFromQuoteDraft instanceorderNumber
(String orderNumber) String that uniquely identifies an order.orderState
(OrderState orderState) Order will be created withOpen
status by default.paymentState
(PaymentState paymentState) Payment state of the Order.quote
(QuoteResourceIdentifier quote) ResourceIdentifier of the Quote from which this Order is created.ResourceIdentifier of the Quote from which this Order is created.quoteStateToAccepted
(Boolean quoteStateToAccepted) Iftrue
, thequoteState
of the referenced Quote will be set toAccepted
.shipmentState
(ShipmentState shipmentState) Shipment state of the Order.state
(StateResourceIdentifier state) Reference to a State indicating the Order's state.Reference to a State indicating the Order's state.version
of the Quote from which an Order is created.ResourceIdentifier of the Quote from which this Order is created.Reference to a State indicating the Order's state.
-
Constructor Details
-
OrderFromQuoteDraftBuilder
public OrderFromQuoteDraftBuilder()
-
-
Method Details
-
quote
public OrderFromQuoteDraftBuilder quote(Function<QuoteResourceIdentifierBuilder, QuoteResourceIdentifierBuilder> builder) ResourceIdentifier of the Quote from which this Order is created. If the Quote has
QuoteState
inAccepted
,Declined
orWithdrawn
then the order creation will fail. The creation will also fail if theQuote
has expired (validTo
check).- Parameters:
builder
- function to build the quote value- Returns:
- Builder
-
withQuote
public OrderFromQuoteDraftBuilder withQuote(Function<QuoteResourceIdentifierBuilder, QuoteResourceIdentifier> builder) ResourceIdentifier of the Quote from which this Order is created. If the Quote has
QuoteState
inAccepted
,Declined
orWithdrawn
then the order creation will fail. The creation will also fail if theQuote
has expired (validTo
check).- Parameters:
builder
- function to build the quote value- Returns:
- Builder
-
quote
ResourceIdentifier of the Quote from which this Order is created. If the Quote has
QuoteState
inAccepted
,Declined
orWithdrawn
then the order creation will fail. The creation will also fail if theQuote
has expired (validTo
check).- Parameters:
quote
- value to be set- Returns:
- Builder
-
version
version
of the Quote from which an Order is created.- Parameters:
version
- value to be set- Returns:
- Builder
-
quoteStateToAccepted
If
true
, thequoteState
of the referenced Quote will be set toAccepted
.- Parameters:
quoteStateToAccepted
- value to be set- Returns:
- Builder
-
orderNumber
String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it's set it cannot be changed. For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression
[a-z0-9_\-]{2,36}
.- Parameters:
orderNumber
- value to be set- Returns:
- Builder
-
paymentState
Payment state of the Order.
- Parameters:
paymentState
- value to be set- Returns:
- Builder
-
shipmentState
Shipment state of the Order.
- Parameters:
shipmentState
- value to be set- Returns:
- Builder
-
orderState
Order will be created with
Open
status by default.- Parameters:
orderState
- value to be set- Returns:
- Builder
-
state
public OrderFromQuoteDraftBuilder state(Function<StateResourceIdentifierBuilder, StateResourceIdentifierBuilder> builder) Reference to a State indicating the Order's state.
- Parameters:
builder
- function to build the state value- Returns:
- Builder
-
withState
public OrderFromQuoteDraftBuilder withState(Function<StateResourceIdentifierBuilder, StateResourceIdentifier> builder) Reference to a State indicating the Order's state.
- Parameters:
builder
- function to build the state value- Returns:
- Builder
-
state
Reference to a State indicating the Order's state.
- Parameters:
state
- value to be set- Returns:
- Builder
-
getQuote
ResourceIdentifier of the Quote from which this Order is created. If the Quote has
QuoteState
inAccepted
,Declined
orWithdrawn
then the order creation will fail. The creation will also fail if theQuote
has expired (validTo
check).- Returns:
- quote
-
getVersion
version
of the Quote from which an Order is created.- Returns:
- version
-
getQuoteStateToAccepted
If
true
, thequoteState
of the referenced Quote will be set toAccepted
.- Returns:
- quoteStateToAccepted
-
getOrderNumber
String that uniquely identifies an order. It can be used to create more human-readable (in contrast to ID) identifier for the order. It should be unique across a project. Once it's set it cannot be changed. For easier use on Get, Update and Delete actions we suggest assigning order numbers that match the regular expression
[a-z0-9_\-]{2,36}
.- Returns:
- orderNumber
-
getPaymentState
Payment state of the Order.
- Returns:
- paymentState
-
getShipmentState
Shipment state of the Order.
- Returns:
- shipmentState
-
getOrderState
Order will be created with
Open
status by default.- Returns:
- orderState
-
getState
Reference to a State indicating the Order's state.
- Returns:
- state
-
build
builds OrderFromQuoteDraft with checking for non-null required values- Specified by:
build
in interfaceio.vrap.rmf.base.client.Builder<OrderFromQuoteDraft>
- Returns:
- OrderFromQuoteDraft
-
buildUnchecked
builds OrderFromQuoteDraft without checking for non-null required values- Returns:
- OrderFromQuoteDraft
-
of
factory method for an instance of OrderFromQuoteDraftBuilder- Returns:
- builder
-
of
create builder for OrderFromQuoteDraft instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-