com.konakart.json.app
Class J_PaymentSchedule

java.lang.Object
  com.konakart.json.app.J_PaymentSchedule

All Implemented Interfaces:

java.io.Serializable

public class J_PaymentSchedule
extends java.lang.Object
implements java.io.Serializable

Defines the details of a payment schedule for recurring billing.

See Also:

Serialized Form

Constructor Summary

J_PaymentSchedule()

Method Summary

java.lang.String	getCustom1()
java.lang.String	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
java.util.Calendar	getDateAdded()
int	getDayOfMonth() Some payment gateways allow you to define the day of the month used for monthly billing.
java.lang.String	getDescription() An optional description of the schedule
int	getId()
java.lang.String	getName() Name of the schedule so that it can be identified
int	getNumPayments() Number of billing occurrences or payments for the subscription.
int	getNumTrialPayments() Number of billing occurrences or payments in the trial period.
int	getTimeLength() Defines the length of time between payments.
int	getTimeUnit() The unit of measurement used to determine the time between payments.
void	setCustom1(java.lang.String _custom1)
void	setCustom2(java.lang.String _custom2)
void	setCustom3(java.lang.String _custom3)
void	setCustom4(java.lang.String _custom4)
void	setCustom5(java.lang.String _custom5)
void	setDateAdded(java.util.Calendar _dateAdded)
void	setDayOfMonth(int _dayOfMonth) Some payment gateways allow you to define the day of the month used for monthly billing.
void	setDescription(java.lang.String _description) An optional description of the schedule
void	setId(int _id)
void	setName(java.lang.String _name) Name of the schedule so that it can be identified
void	setNumPayments(int _numPayments) Number of billing occurrences or payments for the subscription.
void	setNumTrialPayments(int _numTrialPayments) Number of billing occurrences or payments in the trial period.
void	setTimeLength(int _timeLength) Defines the length of time between payments.
void	setTimeUnit(int _timeUnit) The unit of measurement used to determine the time between payments.

Methods inherited from class java.lang.Object

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

Constructor Detail

J_PaymentSchedule

public J_PaymentSchedule()

Method Detail

getId

public int getId()

Returns:

the id

setId

public void setId(int _id)

Parameters:

_id - the id to set

getTimeUnit

public int getTimeUnit()

The unit of measurement used to determine the time between payments. The selected unit is multiplied by the length attribute in order to calculate the time. Can take the following values:

• AdminPaymentSchedule.DAILY
• AdminPaymentSchedule.WEEKLY
• AdminPaymentSchedule.MONTHLY
• AdminPaymentSchedule.YEARLY

Returns:

the timeUnit

setTimeUnit

public void setTimeUnit(int _timeUnit)

The unit of measurement used to determine the time between payments. The selected unit is multiplied by the length attribute in order to calculate the time. Can take the following values:

• AdminPaymentSchedule.DAILY
• AdminPaymentSchedule.WEEKLY
• AdminPaymentSchedule.MONTHLY
• AdminPaymentSchedule.YEARLY

Parameters:

_timeUnit - the timeUnit to set

getTimeLength

public int getTimeLength()

Defines the length of time between payments. The number entered for length is multiplied by the selected unit in order to determine the time.

Returns:

the timeLength

setTimeLength

public void setTimeLength(int _timeLength)

Defines the length of time between payments. The number entered for length is multiplied by the selected unit in order to determine the time.

Parameters:

_timeLength - the timeLength to set

getDayOfMonth

public int getDayOfMonth()

Some payment gateways allow you to define the day of the month used for monthly billing. Not used if values isn't in the range 1-31.

Returns:

the dayOfMonth

setDayOfMonth

public void setDayOfMonth(int _dayOfMonth)

Some payment gateways allow you to define the day of the month used for monthly billing. Not used if values isn't in the range 1-31.

Parameters:

_dayOfMonth - the dayOfMonth to set

getNumPayments

public int getNumPayments()

Number of billing occurrences or payments for the subscription. If set to a negative number, then there is no end date. If a trial period is specified, this number should include the number of trial payments.

Returns:

the numPayments

setNumPayments

public void setNumPayments(int _numPayments)

Number of billing occurrences or payments for the subscription. If set to a negative number, then there is no end date. If a trial period is specified, this number should include the number of trial payments.

Parameters:

_numPayments - the numPayments to set

getNumTrialPayments

public int getNumTrialPayments()

Number of billing occurrences or payments in the trial period. If a trial period is specified, this number must be included in the value for numPayments.

Returns:

the numTrialPayments

setNumTrialPayments

public void setNumTrialPayments(int _numTrialPayments)

Number of billing occurrences or payments in the trial period. If a trial period is specified, this number must be included in the value for numPayments.

Parameters:

_numTrialPayments - the numTrialPayments to set

getCustom1

public java.lang.String getCustom1()

Returns:

the custom1

setCustom1

public void setCustom1(java.lang.String _custom1)

Parameters:

_custom1 - the custom1 to set

getCustom2

public java.lang.String getCustom2()

Returns:

the custom2

setCustom2

public void setCustom2(java.lang.String _custom2)

Parameters:

_custom2 - the custom2 to set

getCustom3

public java.lang.String getCustom3()

Returns:

the custom3

setCustom3

public void setCustom3(java.lang.String _custom3)

Parameters:

_custom3 - the custom3 to set

getCustom4

public java.lang.String getCustom4()

Returns:

the custom4

setCustom4

public void setCustom4(java.lang.String _custom4)

Parameters:

_custom4 - the custom4 to set

getCustom5

public java.lang.String getCustom5()

Returns:

the custom5

setCustom5

public void setCustom5(java.lang.String _custom5)

Parameters:

_custom5 - the custom5 to set

getDateAdded

public java.util.Calendar getDateAdded()

Returns:

the dateAdded

setDateAdded

public void setDateAdded(java.util.Calendar _dateAdded)

Parameters:

_dateAdded - the dateAdded to set

getName

public java.lang.String getName()

Name of the schedule so that it can be identified

Returns:

the name

setName

public void setName(java.lang.String _name)

Name of the schedule so that it can be identified

Parameters:

_name - the name to set

getDescription

public java.lang.String getDescription()

An optional description of the schedule

Returns:

the description

setDescription

public void setDescription(java.lang.String _description)

An optional description of the schedule

Parameters:

_description - the description to set