com.konakartadmin.blif

Interface AdminBillingMgrIf

All Known Implementing Classes:

AdminBillingMgr

public interface AdminBillingMgrIf

AdminCurrencyMgrIf

Method Summary

Modifier and Type	Method and Description
int	deletePaymentSchedule(int id) Delete a Payment Schedule Object
int	deleteSubscription(int id) Delete a Subscription Object
AdminPaymentSchedule	getPaymentSchedule(int id) Returns the payment schedule object for the id parameter, or Null if the payment schedule object doesn't exist in the DB.
AdminPaymentSchedule	getPaymentSchedule(int id, java.sql.Connection con) Returns the payment schedule object for the id parameter, or Null if the payment schedule object doesn't exist in the DB.
AdminPaymentScheduleSearchResult	getPaymentSchedules(AdminPaymentScheduleSearch search, int offset, int size) This returns an AdminPaymentScheduleSearchResult object.
AdminSubscription	getSubscription(int id) Returns the subscription object for the id parameter, or Null if the subscription object doesn't exist in the DB.
AdminSubscriptionSearchResult	getSubscriptions(AdminSubscriptionSearch search, int offset, int size) This returns an AdminSubscriptionSearchResult object.
int	insertPaymentSchedule(AdminPaymentSchedule ps) An AdminPaymentSchedule object is inserted into the database.
int	insertSubscription(AdminSubscription subscription) An AdminSubscription object is inserted into the database.
int	updatePaymentSchedule(AdminPaymentSchedule ps) Update an AdminPaymentSchedule object.
int	updateSubscription(AdminSubscription subscription) Update an AdminSubscription object.

Method Detail

deletePaymentSchedule

int deletePaymentSchedule(int id)
                   throws KKAdminException,
                          org.apache.torque.TorqueException

Delete a Payment Schedule Object

Parameters:

id - The id of the payment schedule object to delete

Returns:

Returns the id of the deleted payment schedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getPaymentSchedule

AdminPaymentSchedule getPaymentSchedule(int id)
                                 throws KKAdminException,
                                        org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException

Returns the payment schedule object for the id parameter, or Null if the payment schedule object doesn't exist in the DB.

Parameters:

id - The id of the payment schedule object

Returns:

Returns a payment schedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

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

getPaymentSchedule

AdminPaymentSchedule getPaymentSchedule(int id,
                                        java.sql.Connection con)
                                 throws KKAdminException,
                                        org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException

Returns the payment schedule object for the id parameter, or Null if the payment schedule object doesn't exist in the DB.

Parameters:

id - The id of the payment schedule object

con - Connection for transaction

Returns:

Returns a payment schedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

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

getPaymentSchedules

AdminPaymentScheduleSearchResult getPaymentSchedules(AdminPaymentScheduleSearch search,
                                                     int offset,
                                                     int size)
                                              throws org.apache.torque.TorqueException,
                                                     com.workingdogs.village.DataSetException,
                                                     KKAdminException

This returns an AdminPaymentScheduleSearchResult object.

Parameters:

search - The object containing the search constraints

offset - the offset in the db

size - the number of records from the specified offset

Returns:

Returns an AdminPaymentScheduleSearchResult object

Throws:

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

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertPaymentSchedule

int insertPaymentSchedule(AdminPaymentSchedule ps)
                   throws KKAdminException,
                          org.apache.torque.TorqueException

An AdminPaymentSchedule object is inserted into the database. The following payment schedule attributes are compulsory:

• name
• timeUnit should be set to a valid time unit
• timeLength should be greater than zero

The id of the new object is returned.

Parameters:

ps - the ps

Returns:

Returns the id of the PaymentSchedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

updatePaymentSchedule

int updatePaymentSchedule(AdminPaymentSchedule ps)
                   throws KKAdminException,
                          org.apache.torque.TorqueException,
                          com.workingdogs.village.DataSetException

Update an AdminPaymentSchedule object. If the value of an attribute is null, the current value is not updated.

Parameters:

ps - An AdminPaymentSchedule object

Returns:

returns the id of the updated AdminPaymentSchedule object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

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

deleteSubscription

int deleteSubscription(int id)
                throws KKAdminException,
                       org.apache.torque.TorqueException

Delete a Subscription Object

Parameters:

id - The id of the subscription object to delete

Returns:

Returns the id of the deleted subscription object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getSubscription

AdminSubscription getSubscription(int id)
                           throws KKAdminException,
                                  org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException

Returns the subscription object for the id parameter, or Null if the subscription object doesn't exist in the DB.

Parameters:

id - The id of the subscription object

Returns:

Returns a subscription object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

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

getSubscriptions

AdminSubscriptionSearchResult getSubscriptions(AdminSubscriptionSearch search,
                                               int offset,
                                               int size)
                                        throws org.apache.torque.TorqueException,
                                               com.workingdogs.village.DataSetException,
                                               KKAdminException

This returns an AdminSubscriptionSearchResult object.

Parameters:

search - The object containing the search constraints

offset - the offset in the db

size - the number of records from the specified offset

Returns:

Returns an AdminSubscriptionSearchResult object

Throws:

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

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertSubscription

int insertSubscription(AdminSubscription subscription)
                throws KKAdminException,
                       org.apache.torque.TorqueException

An AdminSubscription object is inserted into the database. The following subscription attributes are compulsory:

• A valid customerId
• A valid orderId
• A valid productId
• A valid paymentScheduleId
• Amount

The id of the new object is returned.

Parameters:

subscription - the subscription

Returns:

Returns the id of the Subscription object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

updateSubscription

int updateSubscription(AdminSubscription subscription)
                throws KKAdminException,
                       org.apache.torque.TorqueException,
                       com.workingdogs.village.DataSetException

Update an AdminSubscription object. If the value of an attribute is null, the current value is not updated.

Parameters:

subscription - An AdminSubscription object

Returns:

Returns the id of the updated AdminSubscription object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

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