Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.billing

Class Transaction

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Integer,Transaction>

com.aoindustries.aoserv.client.CachedObject<Integer,Transaction>

com.aoindustries.aoserv.client.CachedObjectIntegerKey<Transaction>

com.aoindustries.aoserv.client.billing.Transaction

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, SingleTableObject<Integer,Transaction>

public final class Transaction
extends CachedObjectIntegerKey<Transaction>

Each Account has an account of all the charges and payments processed. Each entry in this account is a Transaction.

Author:

AO Industries, Inc.

See Also:

• Account

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	CONFIRMED	Payment confirmation.
static final byte	NOT_CONFIRMED	Payment confirmation.
static final int	NUM_PAYMENT_CONFIRMATION_STATES
static final int	UNASSIGNED	Represents not being assigned for a field of the int type.
static final byte	WAITING_CONFIRMATION	Payment confirmation.

Fields inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

pkey

Fields inherited from class com.aoindustries.aoserv.client.CachedObject

table

Fields inherited from class com.aoindustries.aoserv.client.AoservObject

USE_ARRAY_OF_DOMAIN, USE_SQL_DATA, USE_SQL_DATA_WRITE

Constructor Summary

Constructors

Constructor	Description
Transaction()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
void	approved(int creditCardTransaction)	Deprecated. Please provide updated cardInfo via approved(int, java.lang.String).
void	approved(int creditCardTransaction, String paymentInfo)
void	declined(int creditCardTransaction)	Deprecated. Please provide updated cardInfo via declined(int, java.lang.String).
void	declined(int creditCardTransaction, String paymentInfo)
Account	getAccount()
Account.Name	getAccount_name()
Administrator	getAdministrator()
User.Name	getAdministrator_username()
Money	getAmount()	Gets the effective amount of quantity * rate.
String	getAprNum()	Deprecated. Please directly access via getPayment().
protected Object	getColumnImpl(int i)
String	getDescription()
Payment	getPayment()
Integer	getPayment_id()
byte	getPaymentConfirmed()
static String	getPaymentConfirmedLabel(int index)
String	getPaymentInfo()
PaymentType	getPaymentType()
String	getPaymentType_name()
Processor	getProcessor()
String	getProcessor_providerId()
int	getQuantity()
Money	getRate()
Account	getSourceAccount()
Account.Name	getSourceAccount_name()
Table.TableId	getTableId()
UnmodifiableTimestamp	getTime()
int	getTransid()
TransactionType	getType()
String	getType_name()
void	held(int creditCardTransaction)	Deprecated. Please provide updated cardInfo via held(int, java.lang.String).
void	held(int creditCardTransaction, String paymentInfo)
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.CachedObjectIntegerKey

equals, getKey, getPkey, hashCode

Methods inherited from class com.aoindustries.aoserv.client.CachedObject

getTable, setTable

Methods inherited from class com.aoindustries.aoserv.client.AoservObject

compare, compare, compare, compare, compareIgnoreCaseConsistentWithEquals, compareTo, compareTo, compareTo, getAccountingCode, getColumn, getColumns, getColumns, getDomainLabel, getDomainLabels, getDomainName, getDto, getEmail, getGecos, getGroupId, getHashedKey, getHashedPassword, getHostname, getInetAddress, getLinuxId, getLinuxUserName, getMacAddress, getMysqlDatabaseName, getMysqlServerName, getMysqlUserName, getPort, getPostgresDatabaseName, getPostgresServerName, getPostgresUserId, getTableSchema, getTimeMillis, getTimeMillis, getUnixPath, getUserId, read, toString, write

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

UNASSIGNED

public static final int UNASSIGNED

Represents not being assigned for a field of the int type.

See Also:

• Constant Field Values

WAITING_CONFIRMATION

public static final byte WAITING_CONFIRMATION

Payment confirmation.

See Also:

• Constant Field Values

CONFIRMED

public static final byte CONFIRMED

Payment confirmation.

See Also:

• Constant Field Values

NOT_CONFIRMED

public static final byte NOT_CONFIRMED

Payment confirmation.

See Also:

• Constant Field Values

NUM_PAYMENT_CONFIRMATION_STATES

public static final int NUM_PAYMENT_CONFIRMATION_STATES

See Also:

• Constant Field Values

Constructor Details

Transaction

@Deprecated
public Transaction()

Deprecated.

Only required for implementation, do not use directly.

See Also:

• init(java.sql.ResultSet)
• read(com.aoapps.hodgepodge.io.stream.StreamableInput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

Method Details

approved

public void approved(int creditCardTransaction,
 String paymentInfo)
              throws IOException,
SQLException

Parameters:

paymentInfo - (Optional) The card info may have been updated during the transaction.

Throws:

IOException

SQLException

approved

@Deprecated
public void approved(int creditCardTransaction)
              throws IOException,
SQLException

Deprecated.

Please provide updated cardInfo via approved(int, java.lang.String).

Throws:

IOException

SQLException

See Also:

• approved(int, java.lang.String)

declined

public void declined(int creditCardTransaction,
 String paymentInfo)
              throws IOException,
SQLException

Parameters:

paymentInfo - (Optional) The card info may have been updated during the transaction.

Throws:

IOException

SQLException

declined

@Deprecated
public void declined(int creditCardTransaction)
              throws IOException,
SQLException

Deprecated.

Please provide updated cardInfo via declined(int, java.lang.String).

Throws:

IOException

SQLException

See Also:

• declined(int, java.lang.String)

held

public void held(int creditCardTransaction,
 String paymentInfo)
          throws IOException,
SQLException

Parameters:

paymentInfo - (Optional) The card info may have been updated during the transaction.

Throws:

IOException

SQLException

held

@Deprecated
public void held(int creditCardTransaction)
          throws IOException,
SQLException

Deprecated.

Please provide updated cardInfo via held(int, java.lang.String).

Throws:

IOException

SQLException

See Also:

• held(int, java.lang.String)

getAprNum

@Deprecated
public String getAprNum()
                 throws SQLException,
IOException

Deprecated.

Please directly access via getPayment(). Beware that getPayment() might return null.

Throws:

SQLException

IOException

See Also:

• getPayment()
• Payment.getAuthorizationApprovalCode()

getAccount_name

public Account.Name getAccount_name()

getAccount

public Account getAccount()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getSourceAccount_name

public Account.Name getSourceAccount_name()

getSourceAccount

public Account getSourceAccount()
                         throws SQLException,
IOException

Throws:

SQLException

IOException

getAdministrator_username

public User.Name getAdministrator_username()

getAdministrator

public Administrator getAdministrator()
                               throws SQLException,
IOException

Throws:

SQLException

IOException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,Transaction>

getDescription

public String getDescription()

getProcessor_providerId

public String getProcessor_providerId()

getProcessor

public Processor getProcessor()
                       throws SQLException,
IOException

Throws:

SQLException

IOException

getPayment_id

public Integer getPayment_id()

getPayment

public Payment getPayment()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getPaymentConfirmed

public byte getPaymentConfirmed()

getPaymentConfirmedLabel

public static String getPaymentConfirmedLabel(int index)

getPaymentInfo

public String getPaymentInfo()

getPaymentType_name

public String getPaymentType_name()

getPaymentType

public PaymentType getPaymentType()
                           throws SQLException,
IOException

Throws:

SQLException

IOException

getAmount

public Money getAmount()

Gets the effective amount of quantity * rate.

getQuantity

public int getQuantity()

getRate

public Money getRate()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Transaction>

getTime

public UnmodifiableTimestamp getTime()

getTransid

public int getTransid()

getType_name

public String getType_name()

getType

public TransactionType getType()
                        throws SQLException,
IOException

Throws:

SQLException

IOException

init

public void init(ResultSet result)
          throws SQLException

Description copied from class: AoservObject

Initializes this object from the raw database contents.

Specified by:

init in class AoservObject<Integer,Transaction>

Parameters:

result - the ResultSet containing the row to copy into this object

Throws:

SQLException

read

public void read(StreamableInput in,
 AoservProtocol.Version protocolVersion)
          throws IOException

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Specified by:

read in class AoservObject<Integer,Transaction>

Throws:

IOException

toStringImpl

public String toStringImpl()

Description copied from class: AoservObject

AoservObject.toString() implementation that is allowed to throw exceptions.

Implementation Note:
This default implementation calls AoservObject.toString() on the key (from AoservObject.getKey()). When the key is null, uses the default implementation from Object.toString().

Overrides:

toStringImpl in class CachedObjectIntegerKey<Transaction>

write

public void write(StreamableOutput out,
 AoservProtocol.Version protocolVersion)
           throws IOException

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Specified by:

write in class AoservObject<Integer,Transaction>

Throws:

IOException