Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class Forwarding

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.email.Forwarding

All Implemented Interfaces:

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

public final class Forwarding
extends CachedObjectIntegerKey<Forwarding>
implements Removable

An EmailForwarding directs incoming mail to a different destination. Any mail sent to the email address is immediately sent on to the configured destination.

Author:

AO Industries, Inc.

See Also:

• Address

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

Method Summary

Modifier and Type	Method	Description
List<CannotRemoveReason<?>>	getCannotRemoveReasons()	Lists the reasons an object may not be removed.
protected Object	getColumnImpl(int i)
Email	getDestination()	Gets the destination.
Address	getEmailAddress()	Gets the email_address.
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	remove()	Removes this object, and all dependant objects, from the system.
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

Forwarding

@Deprecated
public Forwarding()

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

getDestination

public Email getDestination()

Gets the destination.

getEmailAddress

public Address getEmailAddress()
                        throws SQLException,
IOException

Gets the email_address.

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,Forwarding>

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

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

Throws:

IOException

getCannotRemoveReasons

public List<CannotRemoveReason<?>> getCannotRemoveReasons()

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

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

toStringImpl

public String toStringImpl()
                    throws SQLException,
IOException

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

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<Integer,Forwarding>

Throws:

IOException