Interface RenewalTerm.Builder

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

  • Method Details

    • type

      RenewalTerm.Builder type(String type)

      Category of the term being updated.

      Parameters:
      type - Category of the term being updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      RenewalTerm.Builder id(String id)

      The unique identifier for the term.

      Parameters:
      id - The unique identifier for the term.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      RenewalTerm.Builder configuration(RenewalTermConfiguration configuration)

      Additional parameters specified by the acceptor while accepting the term.

      Parameters:
      configuration - Additional parameters specified by the acceptor while accepting the term.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configuration

      default RenewalTerm.Builder configuration(Consumer<RenewalTermConfiguration.Builder> configuration)

      Additional parameters specified by the acceptor while accepting the term.

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

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

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

    • lockoutPeriod

      RenewalTerm.Builder lockoutPeriod(String lockoutPeriod)

      The renewal decision deadline, measured back from the end date of the agreement. This is the last day either party can opt in to or opt out of the renewal. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).

      The field is null when no renewal decision deadline is set. In that case, either party can change the auto-renewal decision up to the end date of the agreement.

      Parameters:
      lockoutPeriod - The renewal decision deadline, measured back from the end date of the agreement. This is the last day either party can opt in to or opt out of the renewal. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).

      The field is null when no renewal decision deadline is set. In that case, either party can change the auto-renewal decision up to the end date of the agreement.

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

    • maxRenewals

      RenewalTerm.Builder maxRenewals(Integer maxRenewals)

      The maximum number of times the agreement can be renewed. The field is null when the number of renewals is unlimited.

      After the agreement reaches this limit, it expires on its end date instead of renewing.

      Parameters:
      maxRenewals - The maximum number of times the agreement can be renewed. The field is null when the number of renewals is unlimited.

      After the agreement reaches this limit, it expires on its end date instead of renewing.

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

    • adjustmentDeadline

      RenewalTerm.Builder adjustmentDeadline(String adjustmentDeadline)

      The date by which the proposer must finalize the price increase for the next renewal, measured back from the end date of the agreement. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).

      This field applies only when PriceIncrease is a PercentageRange. The field is null when PriceIncrease is a FixedPercentage, because the price increase is already fixed and there is nothing for the proposer to finalize. If the proposer doesn't finalize a value by the adjustment deadline, the DefaultValue of the range applies.

      AdjustmentDeadline must be greater than LockoutPeriod.

      Parameters:
      adjustmentDeadline - The date by which the proposer must finalize the price increase for the next renewal, measured back from the end date of the agreement. The duration is represented in the ISO 8601 format in whole days (for example, P30D for 30 days or P60D for 60 days).

      This field applies only when PriceIncrease is a PercentageRange. The field is null when PriceIncrease is a FixedPercentage, because the price increase is already fixed and there is nothing for the proposer to finalize. If the proposer doesn't finalize a value by the adjustment deadline, the DefaultValue of the range applies.

      AdjustmentDeadline must be greater than LockoutPeriod.

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

    • priceIncrease

      RenewalTerm.Builder priceIncrease(PriceIncrease priceIncrease)

      The price increase that is applied each time the agreement renews. The field is null when the price doesn't change at renewal.

      Parameters:
      priceIncrease - The price increase that is applied each time the agreement renews. The field is null when the price doesn't change at renewal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priceIncrease

      default RenewalTerm.Builder priceIncrease(Consumer<PriceIncrease.Builder> priceIncrease)

      The price increase that is applied each time the agreement renews. The field is null when the price doesn't change at renewal.

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

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

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

    • termTemplates

      RenewalTerm.Builder termTemplates(Collection<TermTemplate> termTemplates)

      Defines how specific terms change each time the agreement renews. The field is null when no terms change at renewal.

      Parameters:
      termTemplates - Defines how specific terms change each time the agreement renews. The field is null when no terms change at renewal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • termTemplates

      RenewalTerm.Builder termTemplates(TermTemplate... termTemplates)

      Defines how specific terms change each time the agreement renews. The field is null when no terms change at renewal.

      Parameters:
      termTemplates - Defines how specific terms change each time the agreement renews. The field is null when no terms change at renewal.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • termTemplates

      RenewalTerm.Builder termTemplates(Consumer<TermTemplate.Builder>... termTemplates)

      Defines how specific terms change each time the agreement renews. The field is null when no terms change at renewal.

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

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

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