com.konakart.appif
Interface PaymentScheduleIf

All Known Implementing Classes:

PaymentSchedule

public interface PaymentScheduleIf

Defines the details of a payment schedule for recurring billing.

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.

Method Detail

getId

int getId()

Returns:

the id

setId

void setId(int id)

Parameters:

id - the id to set

getTimeUnit

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

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

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

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

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

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

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

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

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

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

java.lang.String getCustom1()

Returns:

the custom1

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - the custom1 to set

getCustom2

java.lang.String getCustom2()

Returns:

the custom2

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - the custom2 to set

getCustom3

java.lang.String getCustom3()

Returns:

the custom3

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - the custom3 to set

getCustom4

java.lang.String getCustom4()

Returns:

the custom4

setCustom4

void setCustom4(java.lang.String custom4)

Parameters:

custom4 - the custom4 to set

getCustom5

java.lang.String getCustom5()

Returns:

the custom5

setCustom5

void setCustom5(java.lang.String custom5)

Parameters:

custom5 - the custom5 to set

getDateAdded

java.util.Calendar getDateAdded()

Returns:

the dateAdded

setDateAdded

void setDateAdded(java.util.Calendar dateAdded)

Parameters:

dateAdded - the dateAdded to set

getName

java.lang.String getName()

Name of the schedule so that it can be identified

Returns:

the name

setName

void setName(java.lang.String name)

Name of the schedule so that it can be identified

Parameters:

name - the name to set

getDescription

java.lang.String getDescription()

An optional description of the schedule

Returns:

the description

setDescription

void setDescription(java.lang.String description)

An optional description of the schedule

Parameters:

description - the description to set