Interface AgreementViewSummary.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AgreementViewSummary.Builder,AgreementViewSummary>, SdkBuilder<AgreementViewSummary.Builder,AgreementViewSummary>, SdkPojo
Enclosing class:
AgreementViewSummary
@Mutable @NotThreadSafe public static interface AgreementViewSummary.Builder extends SdkPojo, CopyableBuilder<AgreementViewSummary.Builder,AgreementViewSummary>

  • Method Details

    • agreementId

      AgreementViewSummary.Builder agreementId(String agreementId)

      The unique identifier of the agreement.

      Parameters:
      agreementId - The unique identifier of the agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptanceTime

      AgreementViewSummary.Builder acceptanceTime(Instant acceptanceTime)

      The date and time that the agreement was accepted.

      Parameters:
      acceptanceTime - The date and time that the agreement was accepted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • startTime

      AgreementViewSummary.Builder startTime(Instant startTime)

      The date and time when the agreement starts.

      Parameters:
      startTime - The date and time when the agreement starts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTime

      AgreementViewSummary.Builder endTime(Instant endTime)

      The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

      Parameters:
      endTime - The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastUpdateTime

      AgreementViewSummary.Builder lastUpdateTime(Instant lastUpdateTime)

      The date and time when the agreement was last updated. An agreement is updated when any of its attributes or accepted terms change. Amendments, renewals, and a party changing whether the agreement renews are all examples.

      Use the BeforeLastUpdateTime and AfterLastUpdateTime filters to search on this value, and LastUpdateTime as the SortBy value to sort by it. Sorting by LastUpdateTime is supported only when PartyType is Proposer.

      Parameters:
      lastUpdateTime - The date and time when the agreement was last updated. An agreement is updated when any of its attributes or accepted terms change. Amendments, renewals, and a party changing whether the agreement renews are all examples.

      Use the BeforeLastUpdateTime and AfterLastUpdateTime filters to search on this value, and LastUpdateTime as the SortBy value to sort by it. Sorting by LastUpdateTime is supported only when PartyType is Proposer.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agreementType

      AgreementViewSummary.Builder agreementType(String agreementType)

      The type of agreement.

      Parameters:
      agreementType - The type of agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptor

      AgreementViewSummary.Builder acceptor(Acceptor acceptor)

      Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

      Parameters:
      acceptor - Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • acceptor

      default AgreementViewSummary.Builder acceptor(Consumer<Acceptor.Builder> acceptor)

      Details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

      This is a convenience method that creates an instance of the Acceptor.Builder avoiding the need to create one manually via Acceptor.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to acceptor(Acceptor).

      Parameters:
      acceptor - a consumer that will call methods on Acceptor.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • proposer

      AgreementViewSummary.Builder proposer(Proposer proposer)

      Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.

      Parameters:
      proposer - Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proposer

      default AgreementViewSummary.Builder proposer(Consumer<Proposer.Builder> proposer)

      Details of the party proposing the agreement terms, most commonly the seller for PurchaseAgreement.

      This is a convenience method that creates an instance of the Proposer.Builder avoiding the need to create one manually via Proposer.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to proposer(Proposer).

      Parameters:
      proposer - a consumer that will call methods on Proposer.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • proposalSummary

      AgreementViewSummary.Builder proposalSummary(ProposalSummary proposalSummary)

      A summary of the proposal

      Parameters:
      proposalSummary - A summary of the proposal
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • proposalSummary

      default AgreementViewSummary.Builder proposalSummary(Consumer<ProposalSummary.Builder> proposalSummary)

      A summary of the proposal

      This is a convenience method that creates an instance of the ProposalSummary.Builder avoiding the need to create one manually via ProposalSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to proposalSummary(ProposalSummary).

      Parameters:
      proposalSummary - a consumer that will call methods on ProposalSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      AgreementViewSummary.Builder status(String status)

      The current status of the agreement.

      Parameters:
      status - The current status of the agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      AgreementViewSummary.Builder status(AgreementStatus status)

      The current status of the agreement.

      Parameters:
      status - The current status of the agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • entitlements

      AgreementViewSummary.Builder entitlements(Collection<Entitlement> entitlements)

      A list of entitlements associated with the agreement.

      Parameters:
      entitlements - A list of entitlements associated with the agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entitlements

      AgreementViewSummary.Builder entitlements(Entitlement... entitlements)

      A list of entitlements associated with the agreement.

      Parameters:
      entitlements - A list of entitlements associated with the agreement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • entitlements

      AgreementViewSummary.Builder entitlements(Consumer<Entitlement.Builder>... entitlements)

      A list of entitlements associated with the agreement.

      This is a convenience method that creates an instance of the Entitlement.Builder avoiding the need to create one manually via Entitlement.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to entitlements(List<Entitlement>).

      Parameters:
      entitlements - a consumer that will call methods on Entitlement.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • initialAgreementId

      AgreementViewSummary.Builder initialAgreementId(String initialAgreementId)

      The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. You can also use it as the InitialAgreementId filter value to return every agreement in the same chain.

      Parameters:
      initialAgreementId - The unique identifier of the very first agreement in a chain of related agreements, such as renewals or replacements. It stays the same across all agreements in that chain, which lets you trace an agreement back to the original. You can also use it as the InitialAgreementId filter value to return every agreement in the same chain.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • endTimeBehaviorType

      AgreementViewSummary.Builder endTimeBehaviorType(String endTimeBehaviorType)

      The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

      Types include:

      • RENEW – A new agreement is created from the accepted terms of this agreement.

      • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.

      • EXPIRE – The agreement ends and isn't renewed or replaced.

      Parameters:
      endTimeBehaviorType - The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

      Types include:

      • RENEW – A new agreement is created from the accepted terms of this agreement.

      • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.

      • EXPIRE – The agreement ends and isn't renewed or replaced.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endTimeBehaviorType

      AgreementViewSummary.Builder endTimeBehaviorType(EndTimeBehaviorType endTimeBehaviorType)

      The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

      Types include:

      • RENEW – A new agreement is created from the accepted terms of this agreement.

      • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.

      • EXPIRE – The agreement ends and isn't renewed or replaced.

      Parameters:
      endTimeBehaviorType - The behavior of the agreement when it reaches its end date. The field is null for agreements that have no end date, because those agreements never reach an end time.

      Types include:

      • RENEW – A new agreement is created from the accepted terms of this agreement.

      • REPLACE – A new agreement is created from a different offer than the one this agreement was created from. This happens, for example, when a private offer reaches its end date and the acceptor transitions to the public offer for the product.

      • EXPIRE – The agreement ends and isn't renewed or replaced.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endTimeBehaviorReasonCode

      AgreementViewSummary.Builder endTimeBehaviorReasonCode(String endTimeBehaviorReasonCode)

      The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.

      More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

      The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.

      Reason codes include:

      • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.

      • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.

      • NO_RENEWAL_TERM – The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.

      • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

      Parameters:
      endTimeBehaviorReasonCode - The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.

      More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

      The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.

      Reason codes include:

      • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.

      • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.

      • NO_RENEWAL_TERM – The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.

      • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • endTimeBehaviorReasonCode

      AgreementViewSummary.Builder endTimeBehaviorReasonCode(EndTimeBehaviorReasonCode endTimeBehaviorReasonCode)

      The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.

      More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

      The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.

      Reason codes include:

      • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.

      • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.

      • NO_RENEWAL_TERM – The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.

      • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

      Parameters:
      endTimeBehaviorReasonCode - The reason why the agreement doesn't renew at its end date. The field is null when the agreement renews.

      More than one reason can apply to the same agreement. When that happens, the operation returns only one reason code, and PROPOSER_RENEW_OPTED_OUT takes precedence over all others.

      The EnableAutoRenew field reflects only the acceptor's preference, and doesn't reflect the other reasons an agreement might not renew.

      Reason codes include:

      • PROPOSER_RENEW_OPTED_OUT – The proposer opted out of renewing the agreement.

      • ACCEPTOR_RENEW_OPTED_OUT – The acceptor opted out of renewing the agreement.

      • NO_RENEWAL_TERM – The accepted terms of the agreement don't include a renewal term, which is required for an agreement to renew.

      • RENEWAL_LIMIT_EXHAUSTED – The agreement reached the maximum number of renewals allowed by its renewal term.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: