webfunds.sox
Interface Value

All Known Implementing Classes:

AbstractPayment

public interface Value

This class describes a payment object.

Method Summary
byte[]	getDesc()           A description (can be anything, although very long lengths may be refused by some issuers and clients, but at least 2K is guaranteed to be supported by all SOX compatible software) Note that it can be non-ascii, and non readable.
ItemId	getItem()           The type of item (or "currency") of this payment.
long	getQty()           The quantity of the item to be transferred between accounts
int	getSubVersion()           The sub version of the subclass.
int	getType()           The type of payment of this class.
int	getVersion()           The version number for the encoded form.

 

Method Detail

getVersion

public int getVersion()

The version number for the encoded form. 0: sox 2 cheque only 1: AbstractPayment / PaymentFactory {cheque; token; wagner}

getType

public int getType()

The type of payment of this class. See PaymentFactory for types.

getSubVersion

public int getSubVersion()

The sub version of the subclass.

getItem

public ItemId getItem()

The type of item (or "currency") of this payment. E.g. "airmiles", "chips", ... In pure SOX protocol form, this can be any byte array as encoded in ItemId. In extant implementations, this will be the message digest of the Ricardian Contract. In a SOX / practical context this turns out to be more or less mandatory, so included here?

getQty

public long getQty()

The quantity of the item to be transferred between accounts

getDesc

public byte[] getDesc()

A description (can be anything, although very long lengths may be refused by some issuers and clients, but at least 2K is guaranteed to be supported by all SOX compatible software) Note that it can be non-ascii, and non readable. That's up to the client software to deal with.