Interface OrderEdit
- All Superinterfaces:
BaseResource
,Customizable<OrderEdit>
,DomainResource<OrderEdit>
,Identifiable<OrderEdit>
,OrderEditMixin
,Referencable<OrderEdit>
,ResourceIdentifiable<OrderEdit>
,Versioned<OrderEdit>
,WithKey
- All Known Implementing Classes:
OrderEditImpl
Example to create an instance using the builder pattern
OrderEdit orderEdit = OrderEdit.builder()
.id("{id}")
.version(0.3)
.createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.resource(resourceBuilder -> resourceBuilder)
.plusStagedActions(stagedActionsBuilder -> stagedActionsBuilder)
.result(resultBuilder -> resultBuilder)
.build()
-
Method Summary
Modifier and TypeMethodDescriptionstatic OrderEditBuilder
builder()
builder factory method for OrderEditstatic OrderEditBuilder
create builder for OrderEdit instancestatic OrderEdit
factory method to create a deep copy of OrderEditThis field can be used to add textual information regarding the edit.@NotNull ZonedDateTime
@Valid CreatedBy
Present on resources created after 1 February 2019 except for events not tracked.@Valid CustomFields
Custom Fields defined for the entity@NotNull String
getId()
Unique identifier of the OrderEdit.getKey()
User-defined unique identifier of the OrderEdit.@NotNull ZonedDateTime
@Valid LastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.@NotNull @Valid OrderReference
The order to be updated with this edit.@NotNull @Valid OrderEditResult
Contains a preview of the changes in case of unapplied edit.@NotNull @Valid List<StagedOrderUpdateAction>
The actions to apply to the Order.@NotNull Long
The current version of the OrderEdit.static OrderEdit
of()
factory methodstatic OrderEdit
factory method to create a shallow copy OrderEditstatic ReferenceTypeId
void
setComment
(String comment) This field can be used to add textual information regarding the edit.void
setCreatedAt
(ZonedDateTime createdAt) set createdAtvoid
setCreatedBy
(CreatedBy createdBy) Present on resources created after 1 February 2019 except for events not tracked.void
setCustom
(CustomFields custom) set customvoid
Unique identifier of the OrderEdit.void
User-defined unique identifier of the OrderEdit.void
setLastModifiedAt
(ZonedDateTime lastModifiedAt) set lastModifiedAtvoid
setLastModifiedBy
(LastModifiedBy lastModifiedBy) Present on resources created after 1 February 2019 except for events not tracked.void
setResource
(OrderReference resource) The order to be updated with this edit.void
setResult
(OrderEditResult result) Contains a preview of the changes in case of unapplied edit.void
setStagedActions
(StagedOrderUpdateAction... stagedActions) The actions to apply to the Order.void
setStagedActions
(List<StagedOrderUpdateAction> stagedActions) The actions to apply to the Order.void
setVersion
(Long version) The current version of the OrderEdit.static com.fasterxml.jackson.core.type.TypeReference<OrderEdit>
gives a TypeReference for usage with Jackson DataBinddefault <T> T
withOrderEdit
(Function<OrderEdit, T> helper) accessor map functionMethods inherited from interface com.commercetools.api.models.common.BaseResource
withBaseResource
Methods inherited from interface com.commercetools.api.models.Customizable
unwrapCustomizable
Methods inherited from interface com.commercetools.api.models.DomainResource
get
Methods inherited from interface com.commercetools.api.models.order_edit.OrderEditMixin
toReference, toResourceIdentifier
-
Method Details
-
getId
Unique identifier of the OrderEdit.
- Specified by:
getId
in interfaceBaseResource
- Specified by:
getId
in interfaceDomainResource<OrderEdit>
- Specified by:
getId
in interfaceIdentifiable<OrderEdit>
- Specified by:
getId
in interfaceVersioned<OrderEdit>
- Returns:
- id
-
getVersion
The current version of the OrderEdit.
- Specified by:
getVersion
in interfaceBaseResource
- Specified by:
getVersion
in interfaceDomainResource<OrderEdit>
- Specified by:
getVersion
in interfaceVersioned<OrderEdit>
- Returns:
- version
-
getCreatedAt
- Specified by:
getCreatedAt
in interfaceBaseResource
- Returns:
- createdAt
-
getLastModifiedAt
- Specified by:
getLastModifiedAt
in interfaceBaseResource
- Returns:
- lastModifiedAt
-
getLastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Returns:
- lastModifiedBy
-
getCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Returns:
- createdBy
-
getKey
User-defined unique identifier of the OrderEdit.
-
getResource
The order to be updated with this edit.
- Returns:
- resource
-
getStagedActions
The actions to apply to the Order. Cannot be updated after the edit has been applied.
- Returns:
- stagedActions
-
getCustom
Description copied from interface:Customizable
Custom Fields defined for the entity
- Specified by:
getCustom
in interfaceCustomizable<OrderEdit>
- Returns:
- custom
-
getResult
Contains a preview of the changes in case of unapplied edit. For applied edits, it contains the summary of the changes.
- Returns:
- result
-
getComment
This field can be used to add textual information regarding the edit.
- Returns:
- comment
-
setId
Unique identifier of the OrderEdit.
- Specified by:
setId
in interfaceBaseResource
- Parameters:
id
- value to be set
-
setVersion
The current version of the OrderEdit.
- Specified by:
setVersion
in interfaceBaseResource
- Parameters:
version
- value to be set
-
setCreatedAt
set createdAt- Specified by:
setCreatedAt
in interfaceBaseResource
- Parameters:
createdAt
- value to be set
-
setLastModifiedAt
set lastModifiedAt- Specified by:
setLastModifiedAt
in interfaceBaseResource
- Parameters:
lastModifiedAt
- value to be set
-
setLastModifiedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
lastModifiedBy
- value to be set
-
setCreatedBy
Present on resources created after 1 February 2019 except for events not tracked.
- Parameters:
createdBy
- value to be set
-
setKey
User-defined unique identifier of 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 the Order. Cannot be updated after the edit has been applied.
- Parameters:
stagedActions
- values to be set
-
setStagedActions
The actions to apply to the Order. Cannot be updated after the edit has been applied.
- Parameters:
stagedActions
- values to be set
-
setCustom
set custom- Specified by:
setCustom
in interfaceCustomizable<OrderEdit>
- Parameters:
custom
- value to be set
-
setResult
Contains a preview of the changes in case of unapplied edit. For applied edits, it contains the summary of the changes.
- Parameters:
result
- value to be set
-
setComment
This field can be used to add textual information regarding the edit.
- Parameters:
comment
- value to be set
-
of
factory method- Returns:
- instance of OrderEdit
-
of
factory method to create a shallow copy OrderEdit- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
deepCopy
factory method to create a deep copy of OrderEdit- Parameters:
template
- instance to be copied- Returns:
- copy instance
-
builder
builder factory method for OrderEdit- Returns:
- builder
-
builder
create builder for OrderEdit instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-
withOrderEdit
accessor map function- Type Parameters:
T
- mapped type- Parameters:
helper
- function to map the object- Returns:
- mapped value
-
referenceTypeId
-
typeReference
gives a TypeReference for usage with Jackson DataBind- Returns:
- TypeReference
-