org.elastos.hive.service

Interface PaymentService

All Known Implementing Classes:

BackupSubscription, VaultSubscription

public interface PaymentService

The payment service provides users with the way to purchase a paid vault or backup service, such as to subscribe to a new vault or backup with paid pricing plan or extend the purchased subscription service.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<Order>	getOrder(java.lang.String orderId) Obtain the order detail according to the given order id.
java.util.concurrent.CompletableFuture<java.util.List<Order>>	getOrderList() Obtain all the list of order detail.
java.util.concurrent.CompletableFuture<Receipt>	getReceipt(java.lang.String orderId) Obtain the receipt detail according to the order id.
java.util.concurrent.CompletableFuture<java.lang.String>	getVersion() Obtain the version of the payment module.
java.util.concurrent.CompletableFuture<Receipt>	payOrder(java.lang.String orderId, java.lang.String transactionId) Pay for the order with a given id.
java.util.concurrent.CompletableFuture<Order>	placeOrder(java.lang.String planName) Place an order for new subscription or extending the existing subscription service.

Method Detail

placeOrder

java.util.concurrent.CompletableFuture<Order> placeOrder(java.lang.String planName)

Place an order for new subscription or extending the existing subscription service.

Parameters:

planName - the name of the pricing plan

Returns:

return the new order detail when the request successfully was received by back-end node, otherwise return the specific exception.

getOrder

java.util.concurrent.CompletableFuture<Order> getOrder(java.lang.String orderId)

Obtain the order detail according to the given order id.

Parameters:

orderId - order id

Returns:

return the order detail in case there is a order with order id existing. otherwise, return the specific exception.

getOrderList

java.util.concurrent.CompletableFuture<java.util.List<Order>> getOrderList()

Obtain all the list of order detail.

Returns:

return the list of order detail on success, otherwise, return the specific exception.

payOrder

java.util.concurrent.CompletableFuture<Receipt> payOrder(java.lang.String orderId,
                                                         java.lang.String transactionId)

Pay for the order with a given id.

Parameters:

orderId - order id

transactionId - the transaction id on the block-chain.

Returns:

return the receipt detail in case the payment was accepted by hive node, otherwise return the specific exception.

getReceipt

java.util.concurrent.CompletableFuture<Receipt> getReceipt(java.lang.String orderId)

Obtain the receipt detail according to the order id.

Parameters:

orderId - order id.

Returns:

return the receipt detail in case there is a receipt existing, otherwise, return the specific exception.

getVersion

java.util.concurrent.CompletableFuture<java.lang.String> getVersion()

Obtain the version of the payment module.

Returns:

return the version, otherwise, return the specific exception.