Interface OrderEditDraft
- All Superinterfaces:
CustomizableDraft<OrderEditDraft>
,io.vrap.rmf.base.client.Draft<OrderEditDraft>
,WithKey
- All Known Implementing Classes:
OrderEditDraftImpl
public interface OrderEditDraft
extends CustomizableDraft<OrderEditDraft>, WithKey, io.vrap.rmf.base.client.Draft<OrderEditDraft>
OrderEditDraft
Example to create an instance using the builder pattern
Example to create an instance using the builder pattern
OrderEditDraft orderEditDraft = OrderEditDraft.builder()
.resource(resourceBuilder -> resourceBuilder)
.build()
-
Method Summary
Modifier and TypeMethodDescriptionstatic OrderEditDraftBuilder
builder()
builder factory method for OrderEditDraftstatic OrderEditDraftBuilder
builder
(OrderEditDraft template) create builder for OrderEditDraft instancestatic OrderEditDraft
deepCopy
(OrderEditDraft template) factory method to create a deep copy of OrderEditDraftThis field can be used to add additional textual information regarding the edit.@Valid CustomFieldsDraft
The custom fields.When set totrue
the edit is applied on the Order without persisting it.getKey()
User-defined unique identifier for the OrderEdit.@NotNull @Valid OrderReference
The order to be updated with this edit.@Valid List<StagedOrderUpdateAction>
The actions to apply toresource
.static OrderEditDraft
of()
factory methodstatic OrderEditDraft
of
(OrderEditDraft template) factory method to create a shallow copy OrderEditDraftvoid
setComment
(String comment) This field can be used to add additional textual information regarding the edit.void
setCustom
(CustomFieldsDraft custom) The custom fields.void
When set totrue
the edit is applied on the Order without persisting it.void
User-defined unique identifier for the OrderEdit.void
setResource
(OrderReference resource) The order to be updated with this edit.void
setStagedActions
(StagedOrderUpdateAction... stagedActions) The actions to apply toresource
.void
setStagedActions
(List<StagedOrderUpdateAction> stagedActions) The actions to apply toresource
.static com.fasterxml.jackson.core.type.TypeReference<OrderEditDraft>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
withOrderEditDraft
(Function<OrderEditDraft, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.CustomizableDraft
unwrapCustomizableDraft
-
Method Details
-
getKey
User-defined unique identifier for the OrderEdit.
-
getResource
The order to be updated with this edit.
- Returns:
- resource
-
getStagedActions
The actions to apply to
resource
.- Returns:
- stagedActions
-
getCustom
The custom fields.
- Specified by:
getCustom
in interfaceCustomizableDraft<OrderEditDraft>
- Returns:
- custom
-
getComment
This field can be used to add additional textual information regarding the edit.
- Returns:
- comment
-
getDryRun
When set to
true
the edit is applied on the Order without persisting it.- Returns:
- dryRun
-
setKey
User-defined unique identifier for the OrderEdit.
- Parameters:
key
- value to be set
-
setResource
The order to be updated with this edit.
- Parameters:
resource
- value to be set
-
setStagedActions
The actions to apply to
resource
.- Parameters:
stagedActions
- values to be set
-
setStagedActions
The actions to apply to
resource
.- Parameters:
stagedActions
- values to be set
-
setCustom
The custom fields.
- Specified by:
setCustom
in interfaceCustomizableDraft<OrderEditDraft>
- Parameters:
custom
- value to be set
-
setComment
This field can be used to add additional textual information regarding the edit.
- Parameters:
comment
- value to be set
-
setDryRun
When set to
true
the edit is applied on the Order without persisting it.- Parameters:
dryRun
- value to be set
-
of
factory method- Returns:
- instance of OrderEditDraft
-
of
factory method to create a shallow copy OrderEditDraft- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
factory method to create a deep copy of OrderEditDraft- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for OrderEditDraft- Returns:
- builder
-
builder
create builder for OrderEditDraft instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withOrderEditDraft
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-