com.paypal.sdk.models

Class CycleExecution

java.lang.Object

com.paypal.sdk.models.CycleExecution

public class CycleExecution
extends Object

This is a model class for CycleExecution type.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CycleExecution.Builder Class to build instances of CycleExecution.

Constructor Summary

Constructors

Constructor and Description
CycleExecution() Default constructor.
CycleExecution(TenureType tenureType, int sequence, int cyclesCompleted, Integer cyclesRemaining, Integer currentPricingSchemeVersion, Integer totalCycles) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Integer	getCurrentPricingSchemeVersion() Getter for CurrentPricingSchemeVersion.
int	getCyclesCompleted() Getter for CyclesCompleted.
Integer	getCyclesRemaining() Getter for CyclesRemaining.
int	getSequence() Getter for Sequence.
TenureType	getTenureType() Getter for TenureType.
Integer	getTotalCycles() Getter for TotalCycles.
void	setCurrentPricingSchemeVersion(Integer currentPricingSchemeVersion) Setter for CurrentPricingSchemeVersion.
void	setCyclesCompleted(int cyclesCompleted) Setter for CyclesCompleted.
void	setCyclesRemaining(Integer cyclesRemaining) Setter for CyclesRemaining.
void	setSequence(int sequence) Setter for Sequence.
void	setTenureType(TenureType tenureType) Setter for TenureType.
void	setTotalCycles(Integer totalCycles) Setter for TotalCycles.
CycleExecution.Builder	toBuilder() Builds a new CycleExecution.Builder object.
String	toString() Converts this CycleExecution into string format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

CycleExecution

public CycleExecution()

Default constructor.

CycleExecution

public CycleExecution(TenureType tenureType,
                      int sequence,
                      int cyclesCompleted,
                      Integer cyclesRemaining,
                      Integer currentPricingSchemeVersion,
                      Integer totalCycles)

Initialization constructor.

Parameters:

tenureType - TenureType value for tenureType.

sequence - int value for sequence.

cyclesCompleted - int value for cyclesCompleted.

cyclesRemaining - Integer value for cyclesRemaining.

currentPricingSchemeVersion - Integer value for currentPricingSchemeVersion.

totalCycles - Integer value for totalCycles.

Method Detail

getTenureType

public TenureType getTenureType()

Getter for TenureType. The type of the billing cycle.

Returns:

Returns the TenureType

setTenureType

public void setTenureType(TenureType tenureType)

Setter for TenureType. The type of the billing cycle.

Parameters:

tenureType - Value for TenureType

getSequence

public int getSequence()

Getter for Sequence. The order in which to run this cycle among other billing cycles.

Returns:

Returns the int

setSequence

public void setSequence(int sequence)

Setter for Sequence. The order in which to run this cycle among other billing cycles.

Parameters:

sequence - Value for int

getCyclesCompleted

public int getCyclesCompleted()

Getter for CyclesCompleted. The number of billing cycles that have completed.

Returns:

Returns the int

setCyclesCompleted

public void setCyclesCompleted(int cyclesCompleted)

Setter for CyclesCompleted. The number of billing cycles that have completed.

Parameters:

cyclesCompleted - Value for int

getCyclesRemaining

public Integer getCyclesRemaining()

Getter for CyclesRemaining. For a finite billing cycle, cycles_remaining is the number of remaining cycles. For an infinite billing cycle, cycles_remaining is set as 0.

Returns:

Returns the Integer

setCyclesRemaining

public void setCyclesRemaining(Integer cyclesRemaining)

Setter for CyclesRemaining. For a finite billing cycle, cycles_remaining is the number of remaining cycles. For an infinite billing cycle, cycles_remaining is set as 0.

Parameters:

cyclesRemaining - Value for Integer

getCurrentPricingSchemeVersion

public Integer getCurrentPricingSchemeVersion()

Getter for CurrentPricingSchemeVersion. The active pricing scheme version for the billing cycle.

Returns:

Returns the Integer

setCurrentPricingSchemeVersion

public void setCurrentPricingSchemeVersion(Integer currentPricingSchemeVersion)

Setter for CurrentPricingSchemeVersion. The active pricing scheme version for the billing cycle.

Parameters:

currentPricingSchemeVersion - Value for Integer

getTotalCycles

public Integer getTotalCycles()

Getter for TotalCycles. The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).

Returns:

Returns the Integer

setTotalCycles

public void setTotalCycles(Integer totalCycles)

Setter for TotalCycles. The number of times this billing cycle gets executed. Trial billing cycles can only be executed a finite number of times (value between 1 and 999 for total_cycles). Regular billing cycles can be executed infinite times (value of 0 for total_cycles) or a finite number of times (value between 1 and 999 for total_cycles).

Parameters:

totalCycles - Value for Integer

toString

public String toString()

Converts this CycleExecution into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public CycleExecution.Builder toBuilder()

Builds a new CycleExecution.Builder object. Creates the instance with the state of the current model.

Returns:

a new CycleExecution.Builder object