Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.billing

Class PackageDefinition

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.billing.PackageDefinition

All Implemented Interfaces:

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

public final class PackageDefinition
extends CachedObjectIntegerKey<PackageDefinition>
implements Removable

A PackageDefinition stores one unique set of resources, limits, and prices.

Author:

AO Industries, Inc.

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
PackageDefinition()	Deprecated, for removal: This API element is subject to removal in a future version. Only required for implementation, do not use directly.

Method Summary

Modifier and Type	Method	Description
int	copy()
Account	getAccount()	May be null if filtered.
Account.Name	getAccount_name()
List<CannotRemoveReason<Package>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
String	getDescription()
String	getDisplay()
PackageDefinitionLimit	getLimit(Resource resource)
List<PackageDefinitionLimit>	getLimits()
Money	getMonthlyRate()	Gets the monthly rate for the base package or null when unavailable.
TransactionType	getMonthlyRateTransactionType()
String	getName()
PackageCategory	getPackageCategory()
String	getPackageCategory_name()
List<Package>	getPackages()	Gets the list of packages using this definition.
Money	getSetupFee()	Gets the setup fee or null for none.
TransactionType	getSetupFeeTransactionType()
Table.TableId	getTableId()
String	getVersion()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isActive()
boolean	isApproved()
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
void	setActive(boolean active)
void	setLimits(PackageDefinitionLimit[] limits)
String	toStringImpl()	AoservObject.toString() implementation that is allowed to throw exceptions.
void	update(Account business, PackageCategory category, String name, String version, String display, String description, Money setupFee, TransactionType setupFeeTransactionType, Money monthlyRate, TransactionType monthlyRateTransactionType)
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

PackageDefinition

@Deprecated(forRemoval=true)
public PackageDefinition()

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

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

getAccount_name

public Account.Name getAccount_name()

getAccount

public Account getAccount()
                   throws IOException,
SQLException

May be null if filtered.

Throws:

IOException

SQLException

getPackageCategory_name

public String getPackageCategory_name()

getPackageCategory

public PackageCategory getPackageCategory()
                                   throws SQLException,
IOException

Throws:

SQLException

IOException

getPackages

public List<Package> getPackages()
                          throws IOException,
SQLException

Gets the list of packages using this definition.

Throws:

IOException

SQLException

getLimit

public PackageDefinitionLimit getLimit(Resource resource)
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getLimits

public List<PackageDefinitionLimit> getLimits()
                                       throws IOException,
SQLException

Throws:

IOException

SQLException

setLimits

public void setLimits(PackageDefinitionLimit[] limits)
               throws IOException,
SQLException

Throws:

IOException

SQLException

getName

public String getName()

getVersion

public String getVersion()

getDisplay

public String getDisplay()

getDescription

public String getDescription()

getSetupFee

public Money getSetupFee()

Gets the setup fee or null for none.

getSetupFeeTransactionType

public TransactionType getSetupFeeTransactionType()
                                           throws SQLException,
IOException

Throws:

SQLException

IOException

getMonthlyRate

public Money getMonthlyRate()

Gets the monthly rate for the base package or null when unavailable.

getMonthlyRateTransactionType

public TransactionType getMonthlyRateTransactionType()
                                              throws SQLException,
IOException

Throws:

SQLException

IOException

isActive

public boolean isActive()

copy

public int copy()
         throws IOException,
SQLException

Throws:

IOException

SQLException

setActive

public void setActive(boolean active)
               throws IOException,
SQLException

Throws:

IOException

SQLException

isApproved

public boolean isApproved()

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,PackageDefinition>

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

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

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

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

Throws:

IOException

getCannotRemoveReasons

public List<CannotRemoveReason<Package>> getCannotRemoveReasons()
                                                         throws IOException,
SQLException

Description copied from interface: Removable

Lists the reasons an object may not be removed.

Specified by:

getCannotRemoveReasons in interface Removable

Returns:

an empty List<CannotRemoveReason> if this object may be removed, or a list of descriptions

Throws:

IOException

SQLException

remove

public void remove()
            throws IOException,
SQLException

Description copied from interface: Removable

Removes this object, and all dependant objects, from the system.

Specified by:

remove in interface Removable

Throws:

IOException

SQLException

update

public void update(Account business,
 PackageCategory category,
 String name,
 String version,
 String display,
 String description,
 Money setupFee,
 TransactionType setupFeeTransactionType,
 Money monthlyRate,
 TransactionType monthlyRateTransactionType)
            throws IOException,
SQLException

Throws:

IOException

SQLException