Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.account

Class Account

java.lang.Object

com.aoindustries.aoserv.client.AoservObject<Account.Name,Account>

com.aoindustries.aoserv.client.CachedObject<Account.Name,Account>

com.aoindustries.aoserv.client.account.CachedObjectAccountNameKey<Account>

com.aoindustries.aoserv.client.account.Account

All Implemented Interfaces:

Streamable, StreamReadable, StreamWritable, Row, AoservReadable, AoservStreamable, AoservWritable, Disablable, SingleTableObject<Account.Name,Account>, Comparable<Account>

public final class Account
extends CachedObjectAccountNameKey<Account>
implements Disablable, Comparable<Account>

An Account is one distinct set of packages, resources, and permissions. Some businesses may have child businesses associated with them. When that is the case, the top level business is ultimately responsible for all actions taken and resources used by itself and all child businesses.

Author:

AO Industries, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Account.Name	The unique, case-insensitive identifier for an Account.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAXIMUM_BUSINESS_TREE_DEPTH	The maximum depth of the business tree.

Fields inherited from class com.aoindustries.aoserv.client.account.CachedObjectAccountNameKey

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

Method Summary

Modifier and Type	Method	Description
int	addAccountHost(Host server)
int	addCreditCard(Processor processor, String groupName, String cardInfo, byte expirationMonth, short expirationYear, String providerUniqueId, String firstName, String lastName, String companyName, Email email, String phone, String fax, String customerId, String customerTaxId, String streetAddress1, String streetAddress2, String city, String state, String postalCode, CountryCode countryCode, String principalName, String description, String cardNumber)
int	addDisableLog(String disableReason)
void	addNoticeLog(String billingContact, Email emailAddress, String type, int transid)	Deprecated. Please use NoticeLogTable.addNoticeLog(com.aoindustries.aoserv.client.account.Account, java.lang.String, com.aoapps.net.Email, com.aoindustries.aoserv.client.billing.NoticeType, com.aoindustries.aoserv.client.billing.Transaction)
int	addPackage(Account.Name name, PackageDefinition packageDefinition)
int	addPackageDefinition(PackageCategory category, String name, String version, String display, String description, Money setupFee, TransactionType setupFeeTransactionType, Money monthlyRate, TransactionType monthlyRateTransactionType)	Deprecated. Please use PackageDefinitionTable.addPackageDefinition(com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.billing.PackageCategory, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.aoapps.lang.i18n.Money, com.aoindustries.aoserv.client.billing.TransactionType, com.aoapps.lang.i18n.Money, com.aoindustries.aoserv.client.billing.TransactionType) directly.
int	addPayment(Processor processor, String groupName, boolean testMode, int duplicateWindow, String orderNumber, Money amount, Money taxAmount, boolean taxExempt, Money shippingAmount, Money dutyAmount, String shippingFirstName, String shippingLastName, String shippingCompanyName, String shippingStreetAddress1, String shippingStreetAddress2, String shippingCity, String shippingState, String shippingPostalCode, String shippingCountryCode, boolean emailCustomer, Email merchantEmail, String invoiceNumber, String purchaseOrderNumber, String description, Administrator creditCardCreatedBy, String creditCardPrincipalName, Account creditCardAccount, String creditCardGroupName, String creditCardProviderUniqueId, String creditCardMaskedCardNumber, Byte creditCard_expirationMonth, Short creditCard_expirationYear, String creditCardFirstName, String creditCardLastName, String creditCardCompanyName, Email creditCardEmail, String creditCardPhone, String creditCardFax, String creditCardCustomerId, String creditCardCustomerTaxId, String creditCardStreetAddress1, String creditCardStreetAddress2, String creditCardCity, String creditCardState, String creditCardPostalCode, String creditCardCountryCode, String creditCardComments, long authorizationTime, String authorizationPrincipalName)	Deprecated. Please use PaymentTable.addPayment(com.aoindustries.aoserv.client.payment.Processor, com.aoindustries.aoserv.client.account.Account, java.lang.String, boolean, int, java.lang.String, com.aoapps.lang.i18n.Money, com.aoapps.lang.i18n.Money, boolean, com.aoapps.lang.i18n.Money, com.aoapps.lang.i18n.Money, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, com.aoapps.net.Email, java.lang.String, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Administrator, java.lang.String, com.aoindustries.aoserv.client.account.Account, java.lang.String, java.lang.String, java.lang.String, java.lang.Byte, java.lang.Short, java.lang.String, java.lang.String, java.lang.String, com.aoapps.net.Email, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, long, java.lang.String) directly
int	addProfile(String name, boolean isPrivate, String phone, String fax, String address1, String address2, String city, String state, String country, String zip, boolean sendInvoice, String billingContact, Set<Email> billingEmail, Profile.EmailFormat billingEmailFormat, String technicalContact, Set<Email> technicalEmail, Profile.EmailFormat technicalEmailFormat)
int	addTransaction(int timeType, Timestamp time, Account sourceAccount, Administrator administrator, TransactionType type, String description, int quantity, Money rate, PaymentType paymentType, String paymentInfo, Processor processor, byte paymentConfirmed)	Deprecated. Please use TransactionTable.add(int, java.sql.Timestamp, com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.account.Administrator, com.aoindustries.aoserv.client.billing.TransactionType, java.lang.String, int, com.aoapps.lang.i18n.Money, com.aoindustries.aoserv.client.payment.PaymentType, java.lang.String, com.aoindustries.aoserv.client.payment.Processor, byte)
boolean	billParent()
boolean	canAddAccounts()
boolean	canAddBackupServer()
boolean	canCancel()
void	cancel(String cancelReason)
boolean	canDisable()
boolean	canEnable()
boolean	canSeePrices()
int	compareTo(Account o)
void	disable(DisableLog dl)
void	enable()
Monies	getAccountBalance()	Deprecated. Please use TransactionTable.getAccountBalance(com.aoindustries.aoserv.client.account.Account) directly
Monies	getAccountBalance(Timestamp before)	Deprecated. Please use TransactionTable.getAccountBalance(com.aoindustries.aoserv.client.account.Account, java.sql.Timestamp) directly
String	getAccountBalanceString()	Deprecated. Please use getAccountBalance() and Monies.toString() instead
String	getAccountBalanceString(Timestamp before)	Deprecated. Please use getAccountBalance(java.sql.Timestamp) and Monies.toString() instead
AccountHost	getAccountHost(Host host)
List<AccountHost>	getAccountHosts()
Map<PackageCategory,List<PackageDefinition>>	getActivePackageDefinitions()	Gets all active package definitions for this business.
boolean	getAutoEnable()
Monies	getAutoEnableMinimumPayment()
Account	getBillingAccount()	Gets the Account that is responsible for paying the bills created by this business.
List<MonthlyCharge>	getBillingMonthlyCharges()	Gets all monthly charges billed to this account.
Monies	getBillingMonthlyRate()	Gets an approximation of the monthly rate billed to this account.
Brand	getBrand()	Gets the Brand for this business or null if not a brand.
UnmodifiableTimestamp	getCanceled()
String	getCancelReason()
List<Account>	getChildAccounts()
protected Object	getColumnImpl(int i)
Monies	getConfirmedAccountBalance()	Deprecated. Please use TransactionTable.getConfirmedAccountBalance(com.aoindustries.aoserv.client.account.Account) directly
Monies	getConfirmedAccountBalance(Timestamp before)	Deprecated. Please use TransactionTable.getConfirmedAccountBalance(com.aoindustries.aoserv.client.account.Account, java.sql.Timestamp) directly
String	getContractVersion()
UnmodifiableTimestamp	getCreated()
List<Processor>	getCreditCardProcessors()
List<CreditCard>	getCreditCards()
Host	getDefaultHost()
DisableLog	getDisableLog()
String	getDoNotDisableReason()
List<Domain>	getEmailDomains()
List<Forwarding>	getEmailForwarding()
List<List>	getEmailLists()
List<EncryptionKey>	getEncryptionKeys()	Gets all of the encryption keys for this business.
Payment	getLastCreditCardTransaction()	Gets the most recent credit card transaction.
GroupServer	getLinuxServerGroup(Server aoServer)
List<User>	getMailAccounts()
List<MonthlyCharge>	getMonthlyCharges()	Gets all monthly charges from this account.
CreditCard	getMonthlyCreditCard()
Monies	getMonthlyRate()	Gets an approximation of the monthly rate from this account.
Account.Name	getName()
List<NoticeLog>	getNoticeLogs()
PackageDefinition	getPackageDefinition(PackageCategory category, String name, String version)
List<PackageDefinition>	getPackageDefinitions(PackageCategory category)
List<Package>	getPackages()
Account	getParent()
Account.Name	getParent_name()
Profile	getProfile()	Gets the Profile with the highest priority.
List<Profile>	getProfiles()	Gets a list of all profiles for this Account sorted with the highest priority profile at the zero index.
Table.TableId	getTableId()
List<Ticket>	getTickets()
Account	getTopLevelAccount()	Gets the Account in the account tree that is one level down from the top level account.
List<Transaction>	getTransactions()	Deprecated. Please use TransactionTable.getTransactions(com.aoindustries.aoserv.client.account.Account) directly
List<Transaction>	getTransactionsFrom()	Deprecated. Please use TransactionTable.getTransactionsFrom(com.aoindustries.aoserv.client.account.Account) directly
List<WhoisHistoryAccount>	getWhoisHistoryAccounts()
void	init(ResultSet result)	Initializes this object from the raw database contents.
boolean	isAccountOrParent(Account other)	Deprecated. Please use isAccountOrParentOf(com.aoindustries.aoserv.client.account.Account) instead.
boolean	isAccountOrParentOf(Account other)	Determines if this Account is the other account or a parent of it.
boolean	isDisabled()	Checks if this object is disabled.
boolean	isParentOf(Account other)	Determines if this Account is a parent of the other business.
boolean	isRootAccount()
void	move(Server from, Server to, TerminalWriter out)
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	setName(Account.Name name)
void	setUseMonthlyCreditCard(CreditCard creditCard)	Sets the credit card that will be used monthly.
void	write(StreamableOutput out, AoservProtocol.Version protocolVersion)

Methods inherited from class com.aoindustries.aoserv.client.account.CachedObjectAccountNameKey

equals, getKey, hashCode, toStringImpl

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

MAXIMUM_BUSINESS_TREE_DEPTH

public static final int MAXIMUM_BUSINESS_TREE_DEPTH

The maximum depth of the business tree.

See Also:

• Constant Field Values

Constructor Details

Account

@Deprecated
public Account()

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

addProfile

public int addProfile(String name,
 boolean isPrivate,
 String phone,
 String fax,
 String address1,
 String address2,
 String city,
 String state,
 String country,
 String zip,
 boolean sendInvoice,
 String billingContact,
 Set<Email> billingEmail,
 Profile.EmailFormat billingEmailFormat,
 String technicalContact,
 Set<Email> technicalEmail,
 Profile.EmailFormat technicalEmailFormat)
               throws IOException,
SQLException

Throws:

IOException

SQLException

addAccountHost

public int addAccountHost(Host server)
                   throws IOException,
SQLException

Throws:

IOException

SQLException

addCreditCard

public int addCreditCard(Processor processor,
 String groupName,
 String cardInfo,
 byte expirationMonth,
 short expirationYear,
 String providerUniqueId,
 String firstName,
 String lastName,
 String companyName,
 Email email,
 String phone,
 String fax,
 String customerId,
 String customerTaxId,
 String streetAddress1,
 String streetAddress2,
 String city,
 String state,
 String postalCode,
 CountryCode countryCode,
 String principalName,
 String description,
 String cardNumber)
                  throws IOException,
SQLException

Throws:

IOException

SQLException

addPayment

@Deprecated
public int addPayment(Processor processor,
 String groupName,
 boolean testMode,
 int duplicateWindow,
 String orderNumber,
 Money amount,
 Money taxAmount,
 boolean taxExempt,
 Money shippingAmount,
 Money dutyAmount,
 String shippingFirstName,
 String shippingLastName,
 String shippingCompanyName,
 String shippingStreetAddress1,
 String shippingStreetAddress2,
 String shippingCity,
 String shippingState,
 String shippingPostalCode,
 String shippingCountryCode,
 boolean emailCustomer,
 Email merchantEmail,
 String invoiceNumber,
 String purchaseOrderNumber,
 String description,
 Administrator creditCardCreatedBy,
 String creditCardPrincipalName,
 Account creditCardAccount,
 String creditCardGroupName,
 String creditCardProviderUniqueId,
 String creditCardMaskedCardNumber,
 Byte creditCard_expirationMonth,
 Short creditCard_expirationYear,
 String creditCardFirstName,
 String creditCardLastName,
 String creditCardCompanyName,
 Email creditCardEmail,
 String creditCardPhone,
 String creditCardFax,
 String creditCardCustomerId,
 String creditCardCustomerTaxId,
 String creditCardStreetAddress1,
 String creditCardStreetAddress2,
 String creditCardCity,
 String creditCardState,
 String creditCardPostalCode,
 String creditCardCountryCode,
 String creditCardComments,
 long authorizationTime,
 String authorizationPrincipalName)
               throws IOException,
SQLException

Deprecated.

Please use PaymentTable.addPayment(com.aoindustries.aoserv.client.payment.Processor, com.aoindustries.aoserv.client.account.Account, java.lang.String, boolean, int, java.lang.String, com.aoapps.lang.i18n.Money, com.aoapps.lang.i18n.Money, boolean, com.aoapps.lang.i18n.Money, com.aoapps.lang.i18n.Money, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, boolean, com.aoapps.net.Email, java.lang.String, java.lang.String, java.lang.String, com.aoindustries.aoserv.client.account.Administrator, java.lang.String, com.aoindustries.aoserv.client.account.Account, java.lang.String, java.lang.String, java.lang.String, java.lang.Byte, java.lang.Short, java.lang.String, java.lang.String, java.lang.String, com.aoapps.net.Email, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String, long, java.lang.String) directly

Adds a transaction in the pending state.

Throws:

IOException

SQLException

addDisableLog

public int addDisableLog(String disableReason)
                  throws IOException,
SQLException

Throws:

IOException

SQLException

addNoticeLog

@Deprecated
public void addNoticeLog(String billingContact,
 Email emailAddress,
 String type,
 int transid)
                  throws IOException,
SQLException

Deprecated.

Please use NoticeLogTable.addNoticeLog(com.aoindustries.aoserv.client.account.Account, java.lang.String, com.aoapps.net.Email, com.aoindustries.aoserv.client.billing.NoticeType, com.aoindustries.aoserv.client.billing.Transaction)

Throws:

IOException

SQLException

addPackage

public int addPackage(Account.Name name,
 PackageDefinition packageDefinition)
               throws IOException,
SQLException

Throws:

IOException

SQLException

addTransaction

@Deprecated
public int addTransaction(int timeType,
 Timestamp time,
 Account sourceAccount,
 Administrator administrator,
 TransactionType type,
 String description,
 int quantity,
 Money rate,
 PaymentType paymentType,
 String paymentInfo,
 Processor processor,
 byte paymentConfirmed)
                   throws IOException,
SQLException

Deprecated.

Please use TransactionTable.add(int, java.sql.Timestamp, com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.account.Administrator, com.aoindustries.aoserv.client.billing.TransactionType, java.lang.String, int, com.aoapps.lang.i18n.Money, com.aoindustries.aoserv.client.payment.PaymentType, java.lang.String, com.aoindustries.aoserv.client.payment.Processor, byte)

Throws:

IOException

SQLException

canAddBackupServer

public boolean canAddBackupServer()

canAddAccounts

public boolean canAddAccounts()

cancel

public void cancel(String cancelReason)
            throws IllegalArgumentException,
IOException,
SQLException

Throws:

IllegalArgumentException

IOException

SQLException

canCancel

public boolean canCancel()
                  throws IOException,
SQLException

Throws:

IOException

SQLException

isRootAccount

public boolean isRootAccount()
                      throws IOException,
SQLException

Throws:

IOException

SQLException

canDisable

public boolean canDisable()
                   throws IOException,
SQLException

Specified by:

canDisable in interface Disablable

Throws:

IOException

SQLException

canEnable

public boolean canEnable()
                  throws SQLException,
IOException

Specified by:

canEnable in interface Disablable

Throws:

SQLException

IOException

canSeePrices

public boolean canSeePrices()

disable

public void disable(DisableLog dl)
             throws IOException,
SQLException

Specified by:

disable in interface Disablable

Throws:

IOException

SQLException

enable

public void enable()
            throws IOException,
SQLException

Specified by:

enable in interface Disablable

Throws:

IOException

SQLException

getAccountBalance

@Deprecated
public Monies getAccountBalance()
                         throws IOException,
SQLException

Deprecated.

Please use TransactionTable.getAccountBalance(com.aoindustries.aoserv.client.account.Account) directly

Throws:

IOException

SQLException

getAccountBalance

@Deprecated
public Monies getAccountBalance(Timestamp before)
                         throws IOException,
SQLException

Deprecated.

Please use TransactionTable.getAccountBalance(com.aoindustries.aoserv.client.account.Account, java.sql.Timestamp) directly

Throws:

IOException

SQLException

getAccountBalanceString

@Deprecated
public String getAccountBalanceString()
                               throws IOException,
SQLException

Deprecated.

Please use getAccountBalance() and Monies.toString() instead

Gets a comma-separated list of account balances.

Throws:

IOException

SQLException

See Also:

• getAccountBalance()

getAccountBalanceString

@Deprecated
public String getAccountBalanceString(Timestamp before)
                               throws IOException,
SQLException

Deprecated.

Please use getAccountBalance(java.sql.Timestamp) and Monies.toString() instead

Gets a comma-separated list of account balances before a given time.

Throws:

IOException

SQLException

See Also:

• getAccountBalance(java.sql.Timestamp)

getName

public Account.Name getName()

getAutoEnable

public boolean getAutoEnable()

billParent

public boolean billParent()

getAutoEnableMinimumPayment

public Monies getAutoEnableMinimumPayment()
                                   throws IOException,
SQLException

Throws:

IOException

SQLException

getDoNotDisableReason

public String getDoNotDisableReason()

getTopLevelAccount

public Account getTopLevelAccount()
                           throws IOException,
SQLException

Gets the Account in the account tree that is one level down from the top level account.

Throws:

IOException

SQLException

getBillingAccount

public Account getBillingAccount()
                          throws SQLException,
IOException

Gets the Account that is responsible for paying the bills created by this business.

Throws:

SQLException

IOException

getProfile

public Profile getProfile()
                   throws IOException,
SQLException

Gets the Profile with the highest priority.

Throws:

IOException

SQLException

getProfiles

public List<Profile> getProfiles()
                          throws IOException,
SQLException

Gets a list of all profiles for this Account sorted with the highest priority profile at the zero index.

Throws:

IOException

SQLException

getAccountHost

public AccountHost getAccountHost(Host host)
                           throws IOException,
SQLException

Throws:

IOException

SQLException

getAccountHosts

public List<AccountHost> getAccountHosts()
                                  throws IOException,
SQLException

Throws:

IOException

SQLException

getCanceled

public UnmodifiableTimestamp getCanceled()

getCancelReason

public String getCancelReason()

getChildAccounts

public List<Account> getChildAccounts()
                               throws IOException,
SQLException

Throws:

IOException

SQLException

getColumnImpl

protected Object getColumnImpl(int i)

Specified by:

getColumnImpl in class AoservObject<Account.Name,Account>

getConfirmedAccountBalance

@Deprecated
public Monies getConfirmedAccountBalance()
                                  throws IOException,
SQLException

Deprecated.

Please use TransactionTable.getConfirmedAccountBalance(com.aoindustries.aoserv.client.account.Account) directly

Throws:

IOException

SQLException

getConfirmedAccountBalance

@Deprecated
public Monies getConfirmedAccountBalance(Timestamp before)
                                  throws IOException,
SQLException

Deprecated.

Please use TransactionTable.getConfirmedAccountBalance(com.aoindustries.aoserv.client.account.Account, java.sql.Timestamp) directly

Throws:

IOException

SQLException

getContractVersion

public String getContractVersion()

getCreated

public UnmodifiableTimestamp getCreated()

getCreditCardProcessors

public List<Processor> getCreditCardProcessors()
                                        throws IOException,
SQLException

Throws:

IOException

SQLException

getCreditCards

public List<CreditCard> getCreditCards()
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getDefaultHost

public Host getDefaultHost()
                    throws IOException,
SQLException

Throws:

IOException

SQLException

isDisabled

public boolean isDisabled()

Description copied from interface: Disablable

Checks if this object is disabled. This should execute very quickly (not incur any round-trip to any database) and thus does not throw any checked exceptions.

Specified by:

isDisabled in interface Disablable

getDisableLog

public DisableLog getDisableLog()
                         throws SQLException,
IOException

Specified by:

getDisableLog in interface Disablable

Throws:

SQLException

IOException

getEmailForwarding

public List<Forwarding> getEmailForwarding()
                                    throws SQLException,
IOException

Throws:

SQLException

IOException

getEmailLists

public List<List> getEmailLists()
                         throws IOException,
SQLException

Throws:

IOException

SQLException

getLinuxServerGroup

public GroupServer getLinuxServerGroup(Server aoServer)
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getMailAccounts

public List<User> getMailAccounts()
                           throws IOException,
SQLException

Throws:

IOException

SQLException

getMonthlyCreditCard

public CreditCard getMonthlyCreditCard()
                                throws IOException,
SQLException

Throws:

IOException

SQLException

getMonthlyCharges

public List<MonthlyCharge> getMonthlyCharges()
                                      throws SQLException,
IOException

Gets all monthly charges from this account.

Throws:

SQLException

IOException

See Also:

• getMonthlyRate()

getBillingMonthlyCharges

public List<MonthlyCharge> getBillingMonthlyCharges()
                                             throws SQLException,
IOException

Gets all monthly charges billed to this account.

Throws:

SQLException

IOException

See Also:

• getBillingMonthlyRate()

getMonthlyRate

public Monies getMonthlyRate()
                      throws SQLException,
IOException

Gets an approximation of the monthly rate from this account. This is not guaranteed to be exactly the same as the underlying billing database processes.

Returns:

the total monthly rate of all PackageDefinition and MonthlyCharge from this account or null if unavailable.

Throws:

SQLException

IOException

See Also:

• getMonthlyCharges()

getBillingMonthlyRate

public Monies getBillingMonthlyRate()
                             throws SQLException,
IOException

Gets an approximation of the monthly rate billed to this account. This is not guaranteed to be exactly the same as the underlying billing database processes.

Returns:

the total monthly rate of all PackageDefinition and MonthlyCharge billed to this account or null if unavailable.

Throws:

SQLException

IOException

See Also:

• getBillingMonthlyCharges()

getNoticeLogs

public List<NoticeLog> getNoticeLogs()
                              throws IOException,
SQLException

Throws:

IOException

SQLException

getPackages

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

Throws:

IOException

SQLException

getParent_name

public Account.Name getParent_name()

getParent

public Account getParent()
                  throws IOException,
SQLException

Throws:

IOException

SQLException

getEmailDomains

public List<Domain> getEmailDomains()
                             throws SQLException,
IOException

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Account.Name,Account>

getTransactions

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

Deprecated.

Please use TransactionTable.getTransactions(com.aoindustries.aoserv.client.account.Account) directly

Gets transactions that have this account as their applied-to.

Throws:

IOException

SQLException

getTransactionsFrom

@Deprecated
public List<Transaction> getTransactionsFrom()
                                      throws IOException,
SQLException

Deprecated.

Please use TransactionTable.getTransactionsFrom(com.aoindustries.aoserv.client.account.Account) directly

Gets transactions that have this account as their source.

Throws:

IOException

SQLException

getWhoisHistoryAccounts

public List<WhoisHistoryAccount> getWhoisHistoryAccounts()
                                                  throws IOException,
SQLException

Throws:

IOException

SQLException

See Also:

• WhoisHistoryAccountTable.getWhoisHistoryAccounts(com.aoindustries.aoserv.client.account.Account)

isAccountOrParent

@Deprecated
public boolean isAccountOrParent(Account other)
                          throws IOException,
SQLException

Deprecated.

Please use isAccountOrParentOf(com.aoindustries.aoserv.client.account.Account) instead.

Throws:

IOException

SQLException

isAccountOrParentOf

public boolean isAccountOrParentOf(Account other)
                            throws IOException,
SQLException

Determines if this Account is the other account or a parent of it. This is often used for access control between accounts.

Throws:

IOException

SQLException

isParentOf

public boolean isParentOf(Account other)
                   throws IOException,
SQLException

Determines if this Account is a parent of the other business. This is often used for access control between accounts.

Throws:

IOException

SQLException

move

public void move(Server from,
 Server to,
 TerminalWriter out)
          throws IOException,
SQLException

Throws:

IOException

SQLException

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<Account.Name,Account>

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<Account.Name,Account>

Throws:

IOException

setName

public void setName(Account.Name name)
             throws SQLException,
IOException

Throws:

SQLException

IOException

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<Account.Name,Account>

Throws:

IOException

getTickets

public List<Ticket> getTickets()
                        throws SQLException,
IOException

Throws:

SQLException

IOException

getEncryptionKeys

public List<EncryptionKey> getEncryptionKeys()
                                      throws IOException,
SQLException

Gets all of the encryption keys for this business.

Throws:

IOException

SQLException

setUseMonthlyCreditCard

public void setUseMonthlyCreditCard(CreditCard creditCard)
                             throws IOException,
SQLException

Sets the credit card that will be used monthly. Any other selected card will be deselected. If creditCard is null, none will be used automatically.

Throws:

IOException

SQLException

getLastCreditCardTransaction

public Payment getLastCreditCardTransaction()
                                     throws IOException,
SQLException

Gets the most recent credit card transaction.

Throws:

IOException

SQLException

getBrand

public Brand getBrand()
               throws IOException,
SQLException

Gets the Brand for this business or null if not a brand.

Throws:

IOException

SQLException

addPackageDefinition

@Deprecated
public int addPackageDefinition(PackageCategory category,
 String name,
 String version,
 String display,
 String description,
 Money setupFee,
 TransactionType setupFeeTransactionType,
 Money monthlyRate,
 TransactionType monthlyRateTransactionType)
                         throws IOException,
SQLException

Deprecated.

Please use PackageDefinitionTable.addPackageDefinition(com.aoindustries.aoserv.client.account.Account, com.aoindustries.aoserv.client.billing.PackageCategory, java.lang.String, java.lang.String, java.lang.String, java.lang.String, com.aoapps.lang.i18n.Money, com.aoindustries.aoserv.client.billing.TransactionType, com.aoapps.lang.i18n.Money, com.aoindustries.aoserv.client.billing.TransactionType) directly.

Throws:

IOException

SQLException

getPackageDefinition

public PackageDefinition getPackageDefinition(PackageCategory category,
 String name,
 String version)
                                       throws IOException,
SQLException

Throws:

IOException

SQLException

getPackageDefinitions

public List<PackageDefinition> getPackageDefinitions(PackageCategory category)
                                              throws IOException,
SQLException

Throws:

IOException

SQLException

getActivePackageDefinitions

public Map<PackageCategory,List<PackageDefinition>> getActivePackageDefinitions()
                                                                         throws IOException,
SQLException

Gets all active package definitions for this business.

Throws:

IOException

SQLException

compareTo

public int compareTo(Account o)

Specified by:

compareTo in interface Comparable<Account>