Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.billing

Class MonthlyCharge

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.billing.MonthlyCharge

All Implemented Interfaces:

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

public final class MonthlyCharge
extends CachedObjectIntegerKey<MonthlyCharge>

Miscellaneous monthly charges may be applied to an Account. These currently include the recurring charges that are not fully automated. Once all of the accounting data is available in other places of the system, the use of this table will decrease and possibly disappear.

Author:

AO Industries, Inc.

See Also:

• Account
• Transaction

Field Summary

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
MonthlyCharge()	Deprecated. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
Account	getAccount()
Account.Name	getAccount_name()
Money	getAmount()	Gets the effective amount of quantity * rate or null when unknown.
protected Object	getColumnImpl(int i)
UnmodifiableTimestamp	getCreated()
Administrator	getCreatedBy()
String	getDescription()
Package	getPackage()
int	getQuantity()
Money	getRate()	Gets the rate or null when unknown.
Table.TableId	getTableId()
TransactionType	getType()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isActive()
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

Constructor Details

MonthlyCharge

@Deprecated
public MonthlyCharge()

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

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Integer,MonthlyCharge>

getCreated

public UnmodifiableTimestamp getCreated()

getCreatedBy

public Administrator getCreatedBy()
                           throws SQLException,
IOException

Throws:

SQLException

IOException

getAccount_name

public Account.Name getAccount_name()

getAccount

public Account getAccount()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getDescription

public String getDescription()
                      throws SQLException,
IOException

Throws:

SQLException

IOException

getPackage

public Package getPackage()
                   throws SQLException,
IOException

Throws:

SQLException

IOException

getAmount

public Money getAmount()

Gets the effective amount of quantity * rate or null when unknown.

getQuantity

public int getQuantity()

getRate

public Money getRate()

Gets the rate or null when unknown.

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,MonthlyCharge>

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,MonthlyCharge>

Parameters:

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

Throws:

SQLException

isActive

public boolean isActive()

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,MonthlyCharge>

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<MonthlyCharge>

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,MonthlyCharge>

Throws:

IOException