net.dpml.appliance
Interface Appliance

All Superinterfaces:

Remote

All Known Subinterfaces:

Station

public interface Appliance
extends Remote

Appliance interface. An appliance represents a component or component collection that can be comissioned and decommissioned.

Version:

2.0.2

Author:

Digital Product Management Laboratory

Method Summary

void	addApplianceListener(ApplianceListener listener) Add an appliance listener to the appliance.
void	commission() Commission the appliance.
void	decommission() Decommission the appliance.
Appliance[]	getChildren() Return an array of subsidiary appliance instances managed by this appliance.
String	getCodebaseURI() Get the appliance codebase uri.
String	getName() Get the appliance name.
State	getState() Return the current state of the instance.
boolean	isCommissioned() Get the commissioned state of the appliance.
void	removeApplianceListener(ApplianceListener listener) Remove an appliance listener from the appliance.

Method Detail

getState

State getState()
               throws RemoteException

Return the current state of the instance.

Returns:

the current state

Throws:

RemoteException - if a RMI remoting exception occurs

addApplianceListener

void addApplianceListener(ApplianceListener listener)
                          throws RemoteException

Add an appliance listener to the appliance.

Parameters:

listener - the appliance listener

Throws:

RemoteException - if a RMI error occurs

removeApplianceListener

void removeApplianceListener(ApplianceListener listener)
                             throws RemoteException

Remove an appliance listener from the appliance.

Parameters:

listener - the appliance listener

Throws:

RemoteException - if a RMI error occurs

commission

void commission()
                throws IOException

Commission the appliance.

Throws:

IOException - if a I/O error occurs

decommission

void decommission()
                  throws RemoteException

Decommission the appliance.

Throws:

RemoteException - if a RMI error occurs

getChildren

Appliance[] getChildren()
                        throws RemoteException

Return an array of subsidiary appliance instances managed by this appliance.

Returns:

an array of subsidiary appliance instances

Throws:

RemoteException - if a RMI error occurs

getName

String getName()
               throws RemoteException

Get the appliance name.

Returns:

the name

Throws:

RemoteException - if a RMI error occurs

getCodebaseURI

String getCodebaseURI()
                      throws RemoteException

Get the appliance codebase uri.

Returns:

the uri as a string

Throws:

RemoteException - if a RMI error occurs

isCommissioned

boolean isCommissioned()
                       throws RemoteException

Get the commissioned state of the appliance.

Returns:

TRUE if the appliance is commissioned

Throws:

RemoteException - if a RMI error occurs