com.konakart.blif

Interface BillingMgrIf

All Known Implementing Classes:

BillingMgr

public interface BillingMgrIf

BillingMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

Modifier and Type	Method and Description
PaymentSchedule	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.
Subscription[]	getSubscriptionsPerCustomer(java.lang.String sessionId) Returns an array of Subscription objects for a customer referred to by the sessionId parameter.
int	insertSubscription(java.lang.String sessionId, SubscriptionIf subscription) A Subscription object is inserted into the database.
int	insertSubscription(SubscriptionIf subscription) A Subscription object is inserted into the database.
Subscriptions	searchForSubscriptionsPerCustomer(java.lang.String sessionId, DataDescriptorIf dataDesc, SubscriptionSearchIf subscriptionSearch) Return subscriptions matching the search criteria.
void	updateSubscription(java.lang.String sessionId, SubscriptionIf subscription) A Subscription object identified by the subscription passed in as a parameter is updated in the database.
void	updateSubscription(SubscriptionIf subscription) A Subscription object identified by the subscription passed in as a parameter is updated in the database.

Method Detail

insertSubscription

int insertSubscription(java.lang.String sessionId,
                       SubscriptionIf subscription)
                throws java.lang.Exception

A Subscription object is inserted into the database. The following subscription attributes are compulsory:

• A valid orderId belonging to the customer referenced by the sessionId
• A valid productId
• A valid paymentScheduleId
• Amount

The customer id of the Subscription object is fetched from the sessionId. The id of the new object is returned.

The methods:

• beforeInsertSubscription()
• afterInsertSubscription

of the OrderIntegrationMgr are called before and after the insert to allow code to be inserted that calls a payment gateway.

Parameters:

sessionId - The session id of the logged in user

subscription - The subscription object to be inserted

Returns:

Returns the id of the Subscription object

Throws:

java.lang.Exception - an unexpected exception

insertSubscription

int insertSubscription(SubscriptionIf subscription)
                throws java.lang.Exception

A Subscription object is inserted into the database. The following subscription attributes are compulsory:

• A valid orderId belonging to the customer referenced by the sessionId
• A valid productId
• A valid paymentScheduleId
• Amount

The customer id of the Subscription object is fetched from the sessionId. The id of the new object is returned.

The methods:

• beforeInsertSubscription()
• afterInsertSubscription

of the OrderIntegrationMgr are called before and after the insert to allow code to be inserted that calls a payment gateway.

Parameters:

subscription - The subscription object to be inserted

Returns:

Returns the id of the Subscription object

Throws:

java.lang.Exception - an unexpected exception

updateSubscription

void updateSubscription(SubscriptionIf subscription)
                 throws java.lang.Exception

A Subscription object identified by the subscription passed in as a parameter is updated in the database. The methods:

• beforeUpdateSubscription()
• afterUpdateSubscription

of the OrderIntegrationMgr are called before and after the update to allow code to be inserted that calls a payment gateway.

Parameters:

subscription - The subscription object to be updated

Throws:

java.lang.Exception - an unexpected exception

updateSubscription

void updateSubscription(java.lang.String sessionId,
                        SubscriptionIf subscription)
                 throws java.lang.Exception

A Subscription object identified by the subscription passed in as a parameter is updated in the database. A check is made to ensure that the subscription belongs to the customer identified by the sessionId. The methods:

• beforeUpdateSubscription()
• afterUpdateSubscription

of the OrderIntegrationMgr are called before and after the update to allow code to be inserted that calls a payment gateway.

Parameters:

sessionId - The session id of the logged in user

subscription - The subscription object to be updated

Throws:

java.lang.Exception - an unexpected exception

getPaymentSchedule

PaymentSchedule getPaymentSchedule(int id)
                            throws com.konakart.app.KKException,
                                   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:

com.konakart.app.KKException - an unexpected KKException exception

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)

getSubscriptionsPerCustomer

Subscription[] getSubscriptionsPerCustomer(java.lang.String sessionId)
                                    throws java.lang.Exception

Returns an array of Subscription objects for a customer referred to by the sessionId parameter.

Parameters:

sessionId - The session id of the logged in user

Returns:

Returns an array of subscription objects

Throws:

java.lang.Exception - an unexpected exception

searchForSubscriptionsPerCustomer

Subscriptions searchForSubscriptionsPerCustomer(java.lang.String sessionId,
                                                DataDescriptorIf dataDesc,
                                                SubscriptionSearchIf subscriptionSearch)
                                         throws java.lang.Exception

Return subscriptions matching the search criteria.

Parameters:

sessionId - The session id of the logged in user

dataDesc - Used to control the data offset, limit the number of items returned and set the sort

subscriptionSearch - Contains information used to add search constraints

Returns:

A Subscriptions object

Throws:

java.lang.Exception - an unexpected exception