com.paypal.sdk.models

Class Frequency

java.lang.Object

com.paypal.sdk.models.Frequency

public class Frequency
extends Object

This is a model class for Frequency type.

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
Frequency() Default constructor.
Frequency(IntervalUnit intervalUnit, Integer intervalCount) Initialization constructor.

Method Summary

Modifier and Type	Method and Description
Integer	getIntervalCount() Getter for IntervalCount.
IntervalUnit	getIntervalUnit() Getter for IntervalUnit.
void	setIntervalCount(Integer intervalCount) Setter for IntervalCount.
void	setIntervalUnit(IntervalUnit intervalUnit) Setter for IntervalUnit.
Frequency.Builder	toBuilder() Builds a new Frequency.Builder object.
String	toString() Converts this Frequency into string format.

Methods inherited from class java.lang.Object

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

Constructor Detail

Frequency

public Frequency()

Default constructor.

Frequency

public Frequency(IntervalUnit intervalUnit,
                 Integer intervalCount)

Initialization constructor.

Parameters:

intervalUnit - IntervalUnit value for intervalUnit.

intervalCount - Integer value for intervalCount.

Method Detail

getIntervalUnit

public IntervalUnit getIntervalUnit()

Getter for IntervalUnit. The interval at which the subscription is charged or billed.

Returns:

Returns the IntervalUnit

setIntervalUnit

public void setIntervalUnit(IntervalUnit intervalUnit)

Setter for IntervalUnit. The interval at which the subscription is charged or billed.

Parameters:

intervalUnit - Value for IntervalUnit

getIntervalCount

public Integer getIntervalCount()

Getter for IntervalCount. The number of intervals after which a subscriber is billed. For example, if the `interval_unit` is `DAY` with an `interval_count` of `2`, the subscription is billed once every two days. The following table lists the maximum allowed values for the `interval_count` for each `interval_unit`: Interval unit Maximum interval count DAY 365 WEEK 52 MONTH 12 YEAR 1

Returns:

Returns the Integer

setIntervalCount

public void setIntervalCount(Integer intervalCount)

Setter for IntervalCount. The number of intervals after which a subscriber is billed. For example, if the `interval_unit` is `DAY` with an `interval_count` of `2`, the subscription is billed once every two days. The following table lists the maximum allowed values for the `interval_count` for each `interval_unit`: Interval unit Maximum interval count DAY 365 WEEK 52 MONTH 12 YEAR 1

Parameters:

intervalCount - Value for Integer

toString

public String toString()

Converts this Frequency into string format.

Overrides:

toString in class Object

Returns:

String representation of this class

toBuilder

public Frequency.Builder toBuilder()

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

Returns:

a new Frequency.Builder object