org.elastos.hive.subscription.payment

Class PaymentController

java.lang.Object

org.elastos.hive.subscription.payment.PaymentController

public class PaymentController
extends java.lang.Object

The payment controller is the wrapper class for accessing the payment module.

Constructor Summary

Constructors

Constructor and Description
PaymentController(NodeRPCConnection connection)

Method Summary

Modifier and Type	Method and Description
Order	getOrder(java.lang.String orderId) Get the order information by the order id.
java.util.List<Order>	getOrders(java.lang.String subscription) Get the orders by the subscription type.
Receipt	getReceipt(java.lang.String orderId) Get the receipt by the order id.
java.lang.String	getVersion() Get the version of the payment module.
Receipt	payOrder(java.lang.String orderId, java.lang.String transactionId) Pay the order by the order id and the transaction id.
Order	placeOrder(java.lang.String subscription, java.lang.String pricingName) This is for creating the payment order which upgrades the pricing plan of the vault or the backup.

Methods inherited from class java.lang.Object

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

Constructor Detail

PaymentController

public PaymentController(NodeRPCConnection connection)

Method Detail

placeOrder

public Order placeOrder(java.lang.String subscription,
                        java.lang.String pricingName)
                 throws HiveException

This is for creating the payment order which upgrades the pricing plan of the vault or the backup.

Parameters:

subscription - The value is "vault" or "backup".

pricingName - The pricing plan name.

Returns:

The details of the order.

Throws:

HiveException - The error comes from the hive node.

payOrder

public Receipt payOrder(java.lang.String orderId,
                        java.lang.String transactionId)
                 throws HiveException

Pay the order by the order id and the transaction id.

Parameters:

orderId - The order id.

transactionId - The transaction id.

Returns:

The receipt which is the proof of the payment of the order for the user.

Throws:

HiveException - The error comes from the hive node.

getOrder

public Order getOrder(java.lang.String orderId)
               throws HiveException

Get the order information by the order id.

Parameters:

orderId - The order id.

Returns:

The details of the order.

Throws:

HiveException - The error comes from the hive node.

getOrders

public java.util.List<Order> getOrders(java.lang.String subscription)
                                throws HiveException

Get the orders by the subscription type.

Parameters:

subscription - The value is "vault" or "backup".

Returns:

The order list, MUST not empty.

Throws:

HiveException - The error comes from the hive node.

getReceipt

public Receipt getReceipt(java.lang.String orderId)
                   throws HiveException

Get the receipt by the order id.

Parameters:

orderId - The order id.

Returns:

The details of the receipt.

Throws:

HiveException - The error comes from the hive node.

getVersion

public java.lang.String getVersion()
                            throws HiveException

Get the version of the payment module.

Returns:

The version.

Throws:

HiveException - The error comes from the hive node.