org.starhope.catullus
Interface Vehicle

All Known Implementing Classes:

JavaRMIVehicle

public interface Vehicle

WRITEME: Document this type.

Author:

brpocock@star-hope.org

Method Summary

void	connect() WRITEME: Document this method brpocock@star-hope.org
void	disconnect() WRITEME: Document this method brpocock@star-hope.org
String	getURL()
<T extends DataRecord> T	read(Via<T> via, Class<T> klass, int id) WRITEME: Document this method brpocock@star-hope.org
<T extends DataRecord> T	read(Via<T> via, Class<T> klass, String ident) WRITEME: Document this method brpocock@star-hope.org
<T extends DataRecord> void	remove(T obj) WRITEME: Document this method brpocock@star-hope.org
void	setURL(String url)
<T extends DataRecord> T	write(T obj) WRITEME: Document this method brpocock@star-hope.org
<T extends DataRecord> T	writeSync(T obj) WRITEME: Document this method brpocock@star-hope.org

Method Detail

connect

void connect()
             throws NotFoundException,
                    CredentialExpiredException,
                    ForbiddenUserException,
                    NotReadyException,
                    ParameterException,
                    SerialDataException

WRITEME: Document this method brpocock@star-hope.org

Throws:

NotFoundException - perhaps the remote host is unreachable

CredentialExpiredException - the credentials may have once been valid, but are not any more

ForbiddenUserException - the credentials are invalid

NotReadyException - the remote host might not be responding

ParameterException - general problem caused by the caller

SerialDataException - general problem caused in data transfer

disconnect

void disconnect()
                throws SerialDataException,
                       AlreadyUsedException,
                       ParameterException

WRITEME: Document this method brpocock@star-hope.org

Throws:

SerialDataException - general problem caused by data transfer

AlreadyUsedException - not connected

ParameterException - general problem caused by the caller

getURL

String getURL()

Returns:

the url to which this vehicle is/would connect

read

<T extends DataRecord> T read(Via<T> via,
                              Class<T> klass,
                              int id)
                          throws NotReadyException,
                                 NotFoundException

WRITEME: Document this method brpocock@star-hope.org

Type Parameters:

T - WRITEME

Parameters:

via - WRITEME

klass - WRITEME

id - WRITEME

Returns:

WRITEME

Throws:

NotReadyException - WRITEME

NotFoundException - WRITEME

read

<T extends DataRecord> T read(Via<T> via,
                              Class<T> klass,
                              String ident)
                          throws NotReadyException,
                                 NotFoundException

WRITEME: Document this method brpocock@star-hope.org

Type Parameters:

T - WRITEME

Parameters:

via - WRITEME

klass - WRITEME

ident - WRITEME

Returns:

WRITEME

Throws:

NotReadyException - WRITEME

NotFoundException - WRITEME

remove

<T extends DataRecord> void remove(T obj)
            throws NotReadyException,
                   NotFoundException

WRITEME: Document this method brpocock@star-hope.org

Type Parameters:

T - WRITEME

Parameters:

obj - WRITEME

Throws:

NotReadyException - WRITEME

NotFoundException - WRITEME

setURL

void setURL(String url)

Parameters:

url - the URL to which to connect

write

<T extends DataRecord> T write(T obj)
                           throws NotReadyException

WRITEME: Document this method brpocock@star-hope.org

Type Parameters:

T - WRITEME

Parameters:

obj - WRITEME

Throws:

NotReadyException - WRITEME

writeSync

<T extends DataRecord> T writeSync(T obj)
                               throws NotReadyException

WRITEME: Document this method brpocock@star-hope.org

Type Parameters:

T - WRITEME

Parameters:

obj - WRITEME

Throws:

NotReadyException - WRITEME