Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.billing

Class TransactionSearchCriteria

java.lang.Object

com.aoindustries.aoserv.client.billing.TransactionSearchCriteria

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, AoservReadable, AoservStreamable, AoservWritable

public final class TransactionSearchCriteria
extends Object
implements AoservStreamable

A TransactionSearchCriteria stores all the parameters for a Transaction search.wraps all the different ways in which the transaction table may be searched.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	ANY	Value representing any in a search.

Constructor Summary

Constructors

Constructor	Description
TransactionSearchCriteria()	Deprecated, for removal: This API element is subject to removal in a future version. Only required for implementation, do not use directly.
TransactionSearchCriteria(Administrator administrator)
TransactionSearchCriteria(Timestamp after, Timestamp before, int transid, Account.Name account, Account.Name sourceAccount, User.Name administrator, String type, String description, String paymentType, String paymentInfo, byte paymentConfirmed)
TransactionSearchCriteria(Timestamp after, Timestamp before, int transid, Account account, Account sourceAccount, Administrator administrator, TransactionType type, String description, PaymentType paymentType, String paymentInfo, byte paymentConfirmed)

Method Summary

Modifier and Type	Method	Description
Account.Name	getAccount()
User.Name	getAdministrator()
UnmodifiableTimestamp	getAfter()
UnmodifiableTimestamp	getBefore()
static UnmodifiableTimestamp	getDefaultAfter(long time)
String	getDescription()
byte	getPaymentConfirmed()
String	getPaymentInfo()
String	getPaymentType()
Account.Name	getSourceAccount()
List<Transaction>	getTransactions(AoservConnector connector)	Deprecated. Please use TransactionTable.get(com.aoindustries.aoserv.client.billing.TransactionSearchCriteria) directly.
int	getTransid()
String	getType()
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	read(StreamableInput in, String protocolVersion)	Deprecated. This is maintained only for compatibility with the Streamable interface.
void	setAccount(Account.Name account)
void	setAdministrator(User.Name administrator)
void	setAfter(Timestamp after)
void	setBefore(Timestamp before)
void	setDescription(String description)
void	setPaymentConfirmed(byte paymentConfirmed)
void	setPaymentInfo(String paymentInfo)
void	setPaymentType(String paymentType)
void	setSourceAccount(Account.Name sourceAccount)
void	setTransid(int transid)
void	setType(String type)
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)
void	write(StreamableOutput out, String protocolVersion)	Deprecated. This is maintained only for compatibility with the Streamable interface.

Methods inherited from class java.lang.Object

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

Field Details

ANY

public static final int ANY

Value representing any in a search.

See Also:

• Constant Field Values

Constructor Details

TransactionSearchCriteria

@Deprecated(forRemoval=true)
public TransactionSearchCriteria()

Deprecated, for removal: This API element is subject to removal in a future version.

Only required for implementation, do not use directly.

See Also:

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

TransactionSearchCriteria

public TransactionSearchCriteria(Timestamp after,
 Timestamp before,
 int transid,
 Account.Name account,
 Account.Name sourceAccount,
 User.Name administrator,
 String type,
 String description,
 String paymentType,
 String paymentInfo,
 byte paymentConfirmed)

TransactionSearchCriteria

public TransactionSearchCriteria(Timestamp after,
 Timestamp before,
 int transid,
 Account account,
 Account sourceAccount,
 Administrator administrator,
 TransactionType type,
 String description,
 PaymentType paymentType,
 String paymentInfo,
 byte paymentConfirmed)

TransactionSearchCriteria

public TransactionSearchCriteria(Administrator administrator)
                          throws IOException,
SQLException

Throws:

IOException

SQLException

Method Details

getDefaultAfter

public static UnmodifiableTimestamp getDefaultAfter(long time)

getAfter

public UnmodifiableTimestamp getAfter()

getBefore

public UnmodifiableTimestamp getBefore()

getAccount

public Account.Name getAccount()

getSourceAccount

public Account.Name getSourceAccount()

getAdministrator

public User.Name getAdministrator()

getDescription

public String getDescription()

getPaymentConfirmed

public byte getPaymentConfirmed()

getPaymentInfo

public String getPaymentInfo()

getPaymentType

public String getPaymentType()

getType

public String getType()

getTransactions

@Deprecated
public List<Transaction> getTransactions(AoservConnector connector)
                                  throws IOException,
SQLException

Deprecated.

Please use TransactionTable.get(com.aoindustries.aoserv.client.billing.TransactionSearchCriteria) directly.

Throws:

IOException

SQLException

getTransid

public int getTransid()

read

@Deprecated
public void read(StreamableInput in,
 String protocolVersion)
          throws IOException

Deprecated.

This is maintained only for compatibility with the Streamable interface.

Specified by:

read in interface AoservStreamable

Specified by:

read in interface Streamable

Specified by:

read in interface StreamReadable

Throws:

IOException

See Also:

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

read

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

Specified by:

read in interface AoservReadable

Specified by:

read in interface AoservStreamable

Throws:

IOException

setAfter

public void setAfter(Timestamp after)

setBefore

public void setBefore(Timestamp before)

setAccount

public void setAccount(Account.Name account)

setSourceAccount

public void setSourceAccount(Account.Name sourceAccount)

setAdministrator

public void setAdministrator(User.Name administrator)

setDescription

public void setDescription(String description)

setPaymentConfirmed

public void setPaymentConfirmed(byte paymentConfirmed)

setPaymentInfo

public void setPaymentInfo(String paymentInfo)

setPaymentType

public void setPaymentType(String paymentType)

setType

public void setType(String type)

setTransid

public void setTransid(int transid)

write

@Deprecated
public void write(StreamableOutput out,
 String protocolVersion)
           throws IOException

Deprecated.

This is maintained only for compatibility with the Streamable interface.

Specified by:

write in interface AoservStreamable

Specified by:

write in interface Streamable

Specified by:

write in interface StreamWritable

Throws:

IOException

See Also:

• write(com.aoapps.hodgepodge.io.stream.StreamableOutput, com.aoindustries.aoserv.client.schema.AoservProtocol.Version)

write

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

Specified by:

write in interface AoservStreamable

Specified by:

write in interface AoservWritable

Throws:

IOException