Module com.aoindustries.aoserv.client

Package com.aoindustries.aoserv.client.email

Class MajordomoList

java.lang.Object

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

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

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

com.aoindustries.aoserv.client.email.MajordomoList

All Implemented Interfaces:

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

public final class MajordomoList
extends CachedObjectIntegerKey<MajordomoList>

A MajordomoList is one list within a MajordomoServer.

Author:

AO Industries, Inc.

See Also:

• MajordomoServer

Field Summary

Fields

Modifier and Type	Field	Description
static final int	MAX_NAME_LENGTH	The maximum length of an email list name.

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
MajordomoList()	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
protected Object	getColumnImpl(int i)
String	getDefaultInfoFile()
static String	getDefaultInfoFile(DomainName domain, String listName)
String	getDefaultIntroFile()
static String	getDefaultIntroFile(DomainName domain, String listName)
List	getEmailList()
String	getInfoFile()	Gets the info file for the list.
String	getIntroFile()	Gets the intro file for the list.
Address	getListApprovalAddress()
int	getListApprovalAddress_id()
ListAddress	getListListAddress()
Address	getListOwnerAddress()
int	getListOwnerAddress_id()
PipeAddress	getListPipeAddress()
PipeAddress	getListRequestPipeAddress()
MajordomoServer	getMajordomoServer()
int	getMajordomoServer_domain_id()
String	getName()
Address	getOwnerListAddress()
int	getOwnerListAddress_id()
Table.TableId	getTableId()
void	init(ResultSet result)	Initializes this object from the raw database contents.
static boolean	isValidListName(String name)	Checks the validity of a list name.
void	read(StreamableInput in, AoservProtocol.Version protocolVersion)
void	setInfoFile(String file)
void	setIntroFile(String file)
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

Field Details

MAX_NAME_LENGTH

public static final int MAX_NAME_LENGTH

The maximum length of an email list name.

See Also:

• Constant Field Values

Constructor Details

MajordomoList

@Deprecated(forRemoval=true)
public MajordomoList()

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

getDefaultInfoFile

public static String getDefaultInfoFile(DomainName domain,
 String listName)

getDefaultInfoFile

public String getDefaultInfoFile()
                          throws SQLException,
IOException

Throws:

SQLException

IOException

getDefaultIntroFile

public static String getDefaultIntroFile(DomainName domain,
 String listName)

getDefaultIntroFile

public String getDefaultIntroFile()
                           throws SQLException,
IOException

Throws:

SQLException

IOException

getEmailList

public List getEmailList()
                  throws SQLException,
IOException

Throws:

SQLException

IOException

getInfoFile

public String getInfoFile()
                   throws IOException,
SQLException

Gets the info file for the list.

Throws:

IOException

SQLException

getIntroFile

public String getIntroFile()
                    throws IOException,
SQLException

Gets the intro file for the list.

Throws:

IOException

SQLException

getListPipeAddress

public PipeAddress getListPipeAddress()
                               throws SQLException,
IOException

Throws:

SQLException

IOException

getListApprovalAddress_id

public int getListApprovalAddress_id()

getListApprovalAddress

public Address getListApprovalAddress()
                               throws SQLException,
IOException

Throws:

SQLException

IOException

getListListAddress

public ListAddress getListListAddress()
                               throws SQLException,
IOException

Throws:

SQLException

IOException

getListOwnerAddress_id

public int getListOwnerAddress_id()

getListOwnerAddress

public Address getListOwnerAddress()
                            throws SQLException,
IOException

Throws:

SQLException

IOException

getListRequestPipeAddress

public PipeAddress getListRequestPipeAddress()
                                      throws SQLException,
IOException

Throws:

SQLException

IOException

getName

public String getName()

getOwnerListAddress_id

public int getOwnerListAddress_id()

getOwnerListAddress

public Address getOwnerListAddress()
                            throws SQLException,
IOException

Throws:

SQLException

IOException

getMajordomoServer_domain_id

public int getMajordomoServer_domain_id()

getMajordomoServer

public MajordomoServer getMajordomoServer()
                                   throws SQLException,
IOException

Throws:

SQLException

IOException

getTableId

public Table.TableId getTableId()

Specified by:

getTableId in class AoservObject<Integer,MajordomoList>

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

Parameters:

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

Throws:

SQLException

isValidListName

public static boolean isValidListName(String name)

Checks the validity of a list name.

TODO: Self-validating type

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

Throws:

IOException

setInfoFile

public void setInfoFile(String file)
                 throws IOException,
SQLException

Throws:

IOException

SQLException

setIntroFile

public void setIntroFile(String file)
                  throws IOException,
SQLException

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

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

Throws:

IOException