com.rultor.spi

Interface Account

@Immutable
public interface Account

User account.

Since:

1.0

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

Field Summary

Fields

Modifier and Type	Field and Description
static com.jcabi.urn.URN	BANK Who is sending funds when account is funded.

Method Summary

Methods

Modifier and Type	Method and Description
Dollars	balance() Balance.
void	fund(Dollars amount, String details) Fund account.
void	fund(String code) Fund account with coupon.
Sheet	sheet() Sheet.

Field Detail

BANK

static final com.jcabi.urn.URN BANK

Who is sending funds when account is funded.

Method Detail

balance

@NotNull(message="Balance of account is never NULL")
Dollars balance()

Balance.

Returns:

Balance

sheet

@NotNull(message="sheet is never NULL")
Sheet sheet()

Sheet.

Returns:

Sheet

fund

@NotNull(message="account is never NULL")
void fund(Dollars amount,
                       String details)

Fund account.

Parameters:

amount - Amount to add/deduct

details - Explanation

fund

void fund(String code)
          throws InvalidCouponException

Fund account with coupon.

Parameters:

code - Coupon code to use for funding.

Throws:

InvalidCouponException - When wrong coupon code is used.