com.konakart.app

Class PaymentSchedule

java.lang.Object

com.konakart.app.PaymentSchedule

All Implemented Interfaces:

PaymentScheduleIf

public class PaymentSchedule
extends java.lang.Object
implements PaymentScheduleIf

Defines the details of a payment schedule for recurring billing.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DAILY Unit of time
static int	MONTHLY Unit of time
static int	WEEKLY Unit of time
static int	YEARLY Unit of time

Constructor Summary

Constructors

Constructor and Description
PaymentSchedule() Constructor
PaymentSchedule(com.workingdogs.village.Record vr, KKCriteria c) Instantiates the attributes of the Country object from a Record object

Method Summary

Modifier and Type	Method and Description
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DAILY

public static final int DAILY

Unit of time

See Also:

Constant Field Values

WEEKLY

public static final int WEEKLY

Unit of time

See Also:

Constant Field Values

MONTHLY

public static final int MONTHLY

Unit of time

See Also:

Constant Field Values

YEARLY

public static final int YEARLY

Unit of time

See Also:

Constant Field Values

Constructor Detail

PaymentSchedule

public PaymentSchedule()

Constructor

PaymentSchedule

public PaymentSchedule(com.workingdogs.village.Record vr,
                       KKCriteria c)
                throws com.workingdogs.village.DataSetException

Instantiates the attributes of the Country object from a Record object

Parameters:

vr - Record containing data

c - Criteria containing column names

Throws:

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

Returns a string containing the attributes of the Payment Schedule object.

getId

public int getId()

Specified by:

getId in interface PaymentScheduleIf

Returns:

the id

setId

public void setId(int id)

Specified by:

setId in interface PaymentScheduleIf

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

Specified by:

getTimeUnit in interface PaymentScheduleIf

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

Specified by:

setTimeUnit in interface PaymentScheduleIf

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.

Specified by:

getTimeLength in interface PaymentScheduleIf

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.

Specified by:

setTimeLength in interface PaymentScheduleIf

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.

Specified by:

getDayOfMonth in interface PaymentScheduleIf

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.

Specified by:

setDayOfMonth in interface PaymentScheduleIf

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.

Specified by:

getNumPayments in interface PaymentScheduleIf

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.

Specified by:

setNumPayments in interface PaymentScheduleIf

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.

Specified by:

getNumTrialPayments in interface PaymentScheduleIf

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.

Specified by:

setNumTrialPayments in interface PaymentScheduleIf

Parameters:

numTrialPayments - the numTrialPayments to set

getCustom1

public java.lang.String getCustom1()

Specified by:

getCustom1 in interface PaymentScheduleIf

Returns:

the custom1

setCustom1

public void setCustom1(java.lang.String custom1)

Specified by:

setCustom1 in interface PaymentScheduleIf

Parameters:

custom1 - the custom1 to set

getCustom2

public java.lang.String getCustom2()

Specified by:

getCustom2 in interface PaymentScheduleIf

Returns:

the custom2

setCustom2

public void setCustom2(java.lang.String custom2)

Specified by:

setCustom2 in interface PaymentScheduleIf

Parameters:

custom2 - the custom2 to set

getCustom3

public java.lang.String getCustom3()

Specified by:

getCustom3 in interface PaymentScheduleIf

Returns:

the custom3

setCustom3

public void setCustom3(java.lang.String custom3)

Specified by:

setCustom3 in interface PaymentScheduleIf

Parameters:

custom3 - the custom3 to set

getCustom4

public java.lang.String getCustom4()

Specified by:

getCustom4 in interface PaymentScheduleIf

Returns:

the custom4

setCustom4

public void setCustom4(java.lang.String custom4)

Specified by:

setCustom4 in interface PaymentScheduleIf

Parameters:

custom4 - the custom4 to set

getCustom5

public java.lang.String getCustom5()

Specified by:

getCustom5 in interface PaymentScheduleIf

Returns:

the custom5

setCustom5

public void setCustom5(java.lang.String custom5)

Specified by:

setCustom5 in interface PaymentScheduleIf

Parameters:

custom5 - the custom5 to set

getName

public java.lang.String getName()

Name of the schedule so that it can be identified

Specified by:

getName in interface PaymentScheduleIf

Returns:

the name

setName

public void setName(java.lang.String name)

Name of the schedule so that it can be identified

Specified by:

setName in interface PaymentScheduleIf

Parameters:

name - the name to set

getDescription

public java.lang.String getDescription()

An optional description of the schedule

Specified by:

getDescription in interface PaymentScheduleIf

Returns:

the description

setDescription

public void setDescription(java.lang.String description)

An optional description of the schedule

Specified by:

setDescription in interface PaymentScheduleIf

Parameters:

description - the description to set

getDateAdded

public java.util.Calendar getDateAdded()

Specified by:

getDateAdded in interface PaymentScheduleIf

Returns:

the dateAdded

setDateAdded

public void setDateAdded(java.util.Calendar dateAdded)

Specified by:

setDateAdded in interface PaymentScheduleIf

Parameters:

dateAdded - the dateAdded to set