Class LineItemStateTransitionMessageBuilder
- All Implemented Interfaces:
Builder<LineItemStateTransitionMessage>
Example to create an instance using the builder pattern
LineItemStateTransitionMessage lineItemStateTransitionMessage = LineItemStateTransitionMessage.builder()
.id("{id}")
.version(0.3)
.createdAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.lastModifiedAt(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.sequenceNumber(0.3)
.resource(resourceBuilder -> resourceBuilder)
.resourceVersion(0.3)
.lineItemId("{lineItemId}")
.transitionDate(ZonedDateTime.parse("2022-01-01T12:00:00.301Z"))
.quantity(0.3)
.fromState(fromStateBuilder -> fromStateBuilder)
.toState(toStateBuilder -> toStateBuilder)
.build()
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
builds LineItemStateTransitionMessage with checking for non-null required valuesbuilds LineItemStateTransitionMessage without checking for non-null required valuescreatedAt
(ZonedDateTime createdAt) Date and time (UTC) the Message was generated.IDs and references that created the Message.createdBy
(Function<CreatedByBuilder, CreatedByBuilder> builder) IDs and references that created the Message.fromState
(StateReference fromState) State the Line Item was transitioned from.State the Line Item was transitioned from.Date and time (UTC) the Message was generated.IDs and references that created the Message.State the Line Item was transitioned from.getId()
Unique identifier of the Message.Value ofcreatedAt
.IDs and references that last modified the Message.Unique identifier of the Line Item.User-defined unique identifier of the LineItem.Number of Line Items for which the State was transitioned.Reference to the resource on which the change or action was performed.User-provided identifiers of the resource, such askey
orexternalId
.Version of the resource on which the change or action was performed.Message number in relation to other Messages for a given resource.State the Line Item was transitioned to.Date and time (UTC) the transition of the Line Item State was performed.Version of a resource.Unique identifier of the Message.lastModifiedAt
(ZonedDateTime lastModifiedAt) Value ofcreatedAt
.lastModifiedBy
(LastModifiedBy lastModifiedBy) IDs and references that last modified the Message.IDs and references that last modified the Message.lineItemId
(String lineItemId) Unique identifier of the Line Item.lineItemKey
(String lineItemKey) User-defined unique identifier of the LineItem.of()
factory method for an instance of LineItemStateTransitionMessageBuilderof
(LineItemStateTransitionMessage template) create builder for LineItemStateTransitionMessage instanceNumber of Line Items for which the State was transitioned.Reference to the resource on which the change or action was performed.resource
(Function<ReferenceBuilder, Builder<? extends Reference>> builder) Reference to the resource on which the change or action was performed.resourceUserProvidedIdentifiers
(UserProvidedIdentifiers resourceUserProvidedIdentifiers) User-provided identifiers of the resource, such askey
orexternalId
.resourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiersBuilder> builder) User-provided identifiers of the resource, such askey
orexternalId
.resourceVersion
(Long resourceVersion) Version of the resource on which the change or action was performed.sequenceNumber
(Long sequenceNumber) Message number in relation to other Messages for a given resource.toState
(StateReference toState) State the Line Item was transitioned to.State the Line Item was transitioned to.transitionDate
(ZonedDateTime transitionDate) Date and time (UTC) the transition of the Line Item State was performed.Version of a resource.withCreatedBy
(Function<CreatedByBuilder, CreatedBy> builder) IDs and references that created the Message.State the Line Item was transitioned from.IDs and references that last modified the Message.withResourceUserProvidedIdentifiers
(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such askey
orexternalId
.State the Line Item was transitioned to.
-
Constructor Details
-
LineItemStateTransitionMessageBuilder
public LineItemStateTransitionMessageBuilder()
-
-
Method Details
-
id
Unique identifier of the Message. Can be used to track which Messages have been processed.
- Parameters:
id
- value to be set- Returns:
- Builder
-
version
Version of a resource. In case of Messages, this is always
1
.- Parameters:
version
- value to be set- Returns:
- Builder
-
createdAt
Date and time (UTC) the Message was generated.
- Parameters:
createdAt
- value to be set- Returns:
- Builder
-
lastModifiedAt
Value of
createdAt
.- Parameters:
lastModifiedAt
- value to be set- Returns:
- Builder
-
lastModifiedBy
public LineItemStateTransitionMessageBuilder lastModifiedBy(Function<LastModifiedByBuilder, LastModifiedByBuilder> builder) IDs and references that last modified the Message.
- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
withLastModifiedBy
public LineItemStateTransitionMessageBuilder withLastModifiedBy(Function<LastModifiedByBuilder, LastModifiedBy> builder) IDs and references that last modified the Message.
- Parameters:
builder
- function to build the lastModifiedBy value- Returns:
- Builder
-
lastModifiedBy
public LineItemStateTransitionMessageBuilder lastModifiedBy(@Nullable LastModifiedBy lastModifiedBy) IDs and references that last modified the Message.
- Parameters:
lastModifiedBy
- value to be set- Returns:
- Builder
-
createdBy
public LineItemStateTransitionMessageBuilder createdBy(Function<CreatedByBuilder, CreatedByBuilder> builder) IDs and references that created the Message.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
withCreatedBy
public LineItemStateTransitionMessageBuilder withCreatedBy(Function<CreatedByBuilder, CreatedBy> builder) IDs and references that created the Message.
- Parameters:
builder
- function to build the createdBy value- Returns:
- Builder
-
createdBy
IDs and references that created the Message.
- Parameters:
createdBy
- value to be set- Returns:
- Builder
-
sequenceNumber
Message number in relation to other Messages for a given resource. The
sequenceNumber
of the next Message for the resource is the successor of thesequenceNumber
of the current Message. Meaning, thesequenceNumber
of the next Message equals thesequenceNumber
of the current Message + 1.sequenceNumber
can be used to ensure that Messages are processed in the correct order for a particular resource.- Parameters:
sequenceNumber
- value to be set- Returns:
- Builder
-
resource
Reference to the resource on which the change or action was performed.
- Parameters:
resource
- value to be set- Returns:
- Builder
-
resource
public LineItemStateTransitionMessageBuilder resource(Function<ReferenceBuilder, Builder<? extends Reference>> builder) Reference to the resource on which the change or action was performed.
- Parameters:
builder
- function to build the resource value- Returns:
- Builder
-
resourceVersion
Version of the resource on which the change or action was performed.
- Parameters:
resourceVersion
- value to be set- Returns:
- Builder
-
resourceUserProvidedIdentifiers
public LineItemStateTransitionMessageBuilder resourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiersBuilder> builder) User-provided identifiers of the resource, such as
key
orexternalId
. Only present if the resource has such identifiers.- Parameters:
builder
- function to build the resourceUserProvidedIdentifiers value- Returns:
- Builder
-
withResourceUserProvidedIdentifiers
public LineItemStateTransitionMessageBuilder withResourceUserProvidedIdentifiers(Function<UserProvidedIdentifiersBuilder, UserProvidedIdentifiers> builder) User-provided identifiers of the resource, such as
key
orexternalId
. Only present if the resource has such identifiers.- Parameters:
builder
- function to build the resourceUserProvidedIdentifiers value- Returns:
- Builder
-
resourceUserProvidedIdentifiers
public LineItemStateTransitionMessageBuilder resourceUserProvidedIdentifiers(@Nullable UserProvidedIdentifiers resourceUserProvidedIdentifiers) User-provided identifiers of the resource, such as
key
orexternalId
. Only present if the resource has such identifiers.- Parameters:
resourceUserProvidedIdentifiers
- value to be set- Returns:
- Builder
-
lineItemId
Unique identifier of the Line Item.
- Parameters:
lineItemId
- value to be set- Returns:
- Builder
-
lineItemKey
User-defined unique identifier of the LineItem.
- Parameters:
lineItemKey
- value to be set- Returns:
- Builder
-
transitionDate
Date and time (UTC) the transition of the Line Item State was performed.
- Parameters:
transitionDate
- value to be set- Returns:
- Builder
-
quantity
Number of Line Items for which the State was transitioned.
- Parameters:
quantity
- value to be set- Returns:
- Builder
-
fromState
public LineItemStateTransitionMessageBuilder fromState(Function<StateReferenceBuilder, StateReferenceBuilder> builder) State the Line Item was transitioned from.
- Parameters:
builder
- function to build the fromState value- Returns:
- Builder
-
withFromState
public LineItemStateTransitionMessageBuilder withFromState(Function<StateReferenceBuilder, StateReference> builder) State the Line Item was transitioned from.
- Parameters:
builder
- function to build the fromState value- Returns:
- Builder
-
fromState
State the Line Item was transitioned from.
- Parameters:
fromState
- value to be set- Returns:
- Builder
-
toState
public LineItemStateTransitionMessageBuilder toState(Function<StateReferenceBuilder, StateReferenceBuilder> builder) State the Line Item was transitioned to.
- Parameters:
builder
- function to build the toState value- Returns:
- Builder
-
withToState
public LineItemStateTransitionMessageBuilder withToState(Function<StateReferenceBuilder, StateReference> builder) State the Line Item was transitioned to.
- Parameters:
builder
- function to build the toState value- Returns:
- Builder
-
toState
State the Line Item was transitioned to.
- Parameters:
toState
- value to be set- Returns:
- Builder
-
getId
Unique identifier of the Message. Can be used to track which Messages have been processed.
- Returns:
- id
-
getVersion
Version of a resource. In case of Messages, this is always
1
.- Returns:
- version
-
getCreatedAt
Date and time (UTC) the Message was generated.
- Returns:
- createdAt
-
getLastModifiedAt
Value of
createdAt
.- Returns:
- lastModifiedAt
-
getLastModifiedBy
IDs and references that last modified the Message.
- Returns:
- lastModifiedBy
-
getCreatedBy
IDs and references that created the Message.
- Returns:
- createdBy
-
getSequenceNumber
Message number in relation to other Messages for a given resource. The
sequenceNumber
of the next Message for the resource is the successor of thesequenceNumber
of the current Message. Meaning, thesequenceNumber
of the next Message equals thesequenceNumber
of the current Message + 1.sequenceNumber
can be used to ensure that Messages are processed in the correct order for a particular resource.- Returns:
- sequenceNumber
-
getResource
Reference to the resource on which the change or action was performed.
- Returns:
- resource
-
getResourceVersion
Version of the resource on which the change or action was performed.
- Returns:
- resourceVersion
-
getResourceUserProvidedIdentifiers
User-provided identifiers of the resource, such as
key
orexternalId
. Only present if the resource has such identifiers.- Returns:
- resourceUserProvidedIdentifiers
-
getLineItemId
Unique identifier of the Line Item.
- Returns:
- lineItemId
-
getLineItemKey
User-defined unique identifier of the LineItem.
- Returns:
- lineItemKey
-
getTransitionDate
Date and time (UTC) the transition of the Line Item State was performed.
- Returns:
- transitionDate
-
getQuantity
Number of Line Items for which the State was transitioned.
- Returns:
- quantity
-
getFromState
State the Line Item was transitioned from.
- Returns:
- fromState
-
getToState
State the Line Item was transitioned to.
- Returns:
- toState
-
build
builds LineItemStateTransitionMessage with checking for non-null required values- Specified by:
build
in interfaceBuilder<LineItemStateTransitionMessage>
- Returns:
- LineItemStateTransitionMessage
-
buildUnchecked
builds LineItemStateTransitionMessage without checking for non-null required values- Returns:
- LineItemStateTransitionMessage
-
of
factory method for an instance of LineItemStateTransitionMessageBuilder- Returns:
- builder
-
of
create builder for LineItemStateTransitionMessage instance- Parameters:
template
- instance with prefilled values for the builder- Returns:
- builder
-