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

    • id

      RenewalTerm.Builder id(String id)

      The unique identifier of the term.

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

    • type

      RenewalTerm.Builder type(String type)

      The category of the term.

      Parameters:
      type - The category of the term.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      RenewalTerm.Builder type(TermType type)

      The category of the term.

      Parameters:
      type - The category of the term.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxRenewals

      RenewalTerm.Builder maxRenewals(Integer maxRenewals)

      The maximum number of renewals allowed on this offer. Absent means unlimited renewals.

      Parameters:
      maxRenewals - The maximum number of renewals allowed on this offer. Absent means unlimited renewals.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lockoutPeriod

      RenewalTerm.Builder lockoutPeriod(String lockoutPeriod)

      The duration before the agreement end date when the lockout window begins, in ISO 8601 format (for example, P30D). Absent means no lockout.

      Parameters:
      lockoutPeriod - The duration before the agreement end date when the lockout window begins, in ISO 8601 format (for example, P30D). Absent means no lockout.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • adjustmentDeadline

      RenewalTerm.Builder adjustmentDeadline(String adjustmentDeadline)

      The duration before the agreement end date by which the renewal price is finalized, represented in ISO 8601 format (for example, P30D). Only applicable with PercentageRange.

      Parameters:
      adjustmentDeadline - The duration before the agreement end date by which the renewal price is finalized, represented in ISO 8601 format (for example, P30D). Only applicable with PercentageRange.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • priceIncrease

      RenewalTerm.Builder priceIncrease(PriceIncrease priceIncrease)

      The price increase applied at each renewal cycle. Absent means identical pricing on renewal.

      Parameters:
      priceIncrease - The price increase applied at each renewal cycle. Absent means identical pricing on 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 applied at each renewal cycle. Absent means identical pricing on 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)

      Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.

      Parameters:
      termTemplates - Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • termTemplates

      RenewalTerm.Builder termTemplates(TermTemplate... termTemplates)

      Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.

      Parameters:
      termTemplates - Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • termTemplates

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

      Structural templates defining how specific terms are reshaped on each renewal cycle. Absent for upfront-only offers.

      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: