Developers guide

106
* valid for MasterSwitch firmware version 1.X.
*/
public static final String OUTLET_ON_WITH_DELAY = "On with delay";
/**
* <p>
* Setting an outlet to this state will turn the outlet off
* after the sPDUOutletPowerOffTime OID has elapsed. This option is not
* valid for MasterSwitch firmware version 1.X.
*/
public static final String OUTLET_OFF_WITH_DELAY = "Off with delay";
/**
* <p>
* Setting an outlet to this state will turn the outlet off
* after the sPDUOutletPowerOffTime OID has elapsed, wait the
* sPDUOutletRebootDuration OID time, then turn the outlet back on.
* This option is not valid for MasterSwitch firmware version 1.X.
*/
public static final String OUTLET_REBOOT_WITH_DELAY = "Reboot with delay";
/**
* <p>
* An array of all the OUTLET_xxxx states. This can be used by GUI's to
* populate menus.
*/
public static final String[] ALL_STATES = {
OUTLET_ON,
OUTLET_OFF,
OUTLET_REBOOT,
OUTLET_UNKNOWN,
OUTLET_ON_WITH_DELAY,
OUTLET_OFF_WITH_DELAY,
OUTLET_REBOOT_WITH_DELAY
};
/**
* The number of outlets.
* <p>
* Note that outlets are referenced from 1 to NUM_OUTLETS
*/
public final int NUM_OUTLETS = 8;
/**
* This call will Block until either it returns successfully, or an error occurs
* <p>
* @throws apt.masterswitch.MasterswitchException
* @param outlet The Masterswitch outlet. This is a number between 1 and 8
* @return The String label corresponding to the outlet. Up to 20 Chars
*/
public String getOutletName(int outlet) throws MasterswitchException;
/**
* This call will Block until either it returns successfully, or an error occurs
* <p>
* @throws apt.masterswitch.MasterswitchException
* @param outlet The Masterswitch outlet. This is a number between 1 and 8
* @return The String value corresponding to the outlets state. These values are defined in Masterswitch
* @exception MasterswitchException
*/
public String getOutletState(int outlet) throws MasterswitchException;
/**
* Set the outlets name
* <p>
* This call will Block until either it returns successfully, or an error occurs
* <p>
* @throws apt.masterswitch.MasterswitchException
* @param outlet The Masterswitch outlet. This is a number between 1 and 8
* @param newName The new name for the specified outlet. Maximum of 20 chars
* @return The String label corresponding to the outlet.
* @exception MasterswitchException
*/
public String setOutletName(int outlet, String newName) throws MasterswitchException;
/**
* This call will Block until either it returns successfully, or an error occurs
* <p>
* @throws apt.masterswitch.MasterswitchException