net.dpml.appliance
Interface Appliance

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
Station

public interface Appliance
extends java.rmi.Remote

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

Version:
2.0.3
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.
 java.lang.String getCodebaseURI()
          Get the appliance codebase uri.
 java.lang.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 java.rmi.RemoteException
Return the current state of the instance.

Returns:
the current state
Throws:
java.rmi.RemoteException - if a RMI remoting exception occurs

addApplianceListener

void addApplianceListener(ApplianceListener listener)
                          throws java.rmi.RemoteException
Add an appliance listener to the appliance.

Parameters:
listener - the appliance listener
Throws:
java.rmi.RemoteException - if a RMI error occurs

removeApplianceListener

void removeApplianceListener(ApplianceListener listener)
                             throws java.rmi.RemoteException
Remove an appliance listener from the appliance.

Parameters:
listener - the appliance listener
Throws:
java.rmi.RemoteException - if a RMI error occurs

commission

void commission()
                throws java.io.IOException
Commission the appliance.

Throws:
java.io.IOException - if a I/O error occurs

decommission

void decommission()
                  throws java.rmi.RemoteException
Decommission the appliance.

Throws:
java.rmi.RemoteException - if a RMI error occurs

getChildren

Appliance[] getChildren()
                        throws java.rmi.RemoteException
Return an array of subsidiary appliance instances managed by this appliance.

Returns:
an array of subsidiary appliance instances
Throws:
java.rmi.RemoteException - if a RMI error occurs

getName

java.lang.String getName()
                         throws java.rmi.RemoteException
Get the appliance name.

Returns:
the name
Throws:
java.rmi.RemoteException - if a RMI error occurs

getCodebaseURI

java.lang.String getCodebaseURI()
                                throws java.rmi.RemoteException
Get the appliance codebase uri.

Returns:
the uri as a string
Throws:
java.rmi.RemoteException - if a RMI error occurs

isCommissioned

boolean isCommissioned()
                       throws java.rmi.RemoteException
Get the commissioned state of the appliance.

Returns:
TRUE if the appliance is commissioned
Throws:
java.rmi.RemoteException - if a RMI error occurs