com.konakartadmin.app
Class AdminPaymentSchedule

java.lang.Object
  extended by com.konakartadmin.app.AdminPaymentSchedule
All Implemented Interfaces:
AdminObjectIf

public class AdminPaymentSchedule
extends java.lang.Object
implements AdminObjectIf

Defines the details of a payment schedule for recurring billing.


Field Summary
private  java.lang.String custom1
          custom field
private  java.lang.String custom2
          custom field
private  java.lang.String custom3
          custom field
private  java.lang.String custom4
          custom field
private  java.lang.String custom5
          custom field
static int DAILY
          Unit of time
private  java.util.Date dateAdded
          dateAdded
private  int dayOfMonth
          Some payment gateways allow you to define the day of the month used for monthly billing.
private  java.lang.String description
          An optional description of the schedule
private  int id
          Id
static int MONTHLY
          Unit of time
private  java.lang.String name
          Name of the schedule so that it can be identified
private  int numPayments
          Number of billing occurrences or payments for the subscription.
private  int numTrialPayments
          Number of billing occurrences or payments in the trial period.
private  int timeLength
          Defines the length of time between payments.
private  int timeUnit
          The unit of measurement used to determine the time between payments.
static int WEEKLY
          Unit of time
static int YEARLY
          Unit of time
 
Constructor Summary
AdminPaymentSchedule()
          Constructor
AdminPaymentSchedule(com.workingdogs.village.Record vr, org.apache.torque.util.Criteria c)
          Instantiates the attributes of the Country object from a Record object
 
Method Summary
 java.lang.String getCustom1()
           
 java.lang.String getCustom2()
           
 java.lang.String getCustom3()
           
 java.lang.String getCustom4()
           
 java.lang.String getCustom5()
           
 java.util.Date 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.Date 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

id

private int id
Id


name

private java.lang.String name
Name of the schedule so that it can be identified


description

private java.lang.String description
An optional description of the schedule


timeUnit

private 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:


timeLength

private 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.


dayOfMonth

private 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.


numPayments

private 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.


numTrialPayments

private 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.


custom1

private java.lang.String custom1
custom field


custom2

private java.lang.String custom2
custom field


custom3

private java.lang.String custom3
custom field


custom4

private java.lang.String custom4
custom field


custom5

private java.lang.String custom5
custom field


dateAdded

private java.util.Date dateAdded
dateAdded

Constructor Detail

AdminPaymentSchedule

public AdminPaymentSchedule()
Constructor


AdminPaymentSchedule

public AdminPaymentSchedule(com.workingdogs.village.Record vr,
                            org.apache.torque.util.Criteria 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
Method Detail

toString

public java.lang.String toString()
Specified by:
toString in interface AdminObjectIf
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 AdminObjectIf
Returns:
the id

setId

public void setId(int id)
Specified by:
setId in interface AdminObjectIf
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:

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:

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.Date getDateAdded()
Returns:
the dateAdded

setDateAdded

public void setDateAdded(java.util.Date 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


Copyright © 2011 DS Data Systems UK Ltd.