disman
Class Launch

java.lang.Object
  |
  +--disman.Launch

public class Launch
extends java.lang.Object


Field Summary
static int ADMIN_STATUS_AUTOSTART
          Valid state
static int ADMIN_STATUS_DISABLED
          Valid state
static int ADMIN_STATUS_ENABLED
          Valid state
static java.lang.String[] adminStatusStrings
          Array of admin state strings.
static int CONTROL_ABORT
          Valid control code
static int CONTROL_NOP
          Valid control code
static int CONTROL_RESUME
          Valid control code
static int CONTROL_SUSPEND
          Valid control code
static java.lang.String[] controlStrings
          Array of exit code strings.
static long LIFETIME_NEVERENDING
          Special smLifeTime value for never ending scripts.
static int OPER_STATUS_DISABLED
          Valid state
static int OPER_STATUS_ENABLED
          Valid state
static int OPER_STATUS_EXPIRED
          Valid state
static java.lang.String[] operStatusStrings
          Array of operation state strings.
static int ROW_STATUS_ACTIVE
          Valid row status
static int ROW_STATUS_CREATE_AND_GO
          Valid row status
static int ROW_STATUS_CREATE_AND_WAIT
          Valid row status
static int ROW_STATUS_DESTROY
          Valid row status
static int ROW_STATUS_NOT_IN_SERVICE
          Valid row status
static int ROW_STATUS_NOT_READY
          Valid row status
static java.lang.String[] rowStatusStrings
          Array of row status strings.
static int STORAGE_TYPE_NON_VOLATILE
          Valid storage type
static int STORAGE_TYPE_OTHER
          Valid storage type
static int STORAGE_TYPE_PERMANENT
          Valid storage type
static int STORAGE_TYPE_READ_ONLY
          Valid storage type
static int STORAGE_TYPE_VOLATILE
          Valid storage type
static java.lang.String[] storageTypeStrings
          Array of storage type strings.
 
Constructor Summary
Launch(Disman disman, java.lang.String owner, java.lang.String name)
          Create a Launch object for a given Disman object indexed by a given owner and name by retrieval from the agent.
Launch(Disman disman, java.lang.String owner, java.lang.String name, Script script)
          Create a Launch object for a given Disman object and a given Script object indexed by a given owner and name by creating it at the agent.
 
Method Summary
 java.lang.String call()
          Start a script from this launch button, block until it has been terminated and return the result string.
 void disable()
          Disable the launch button.
 void enable()
          Enable this launch button.
 int getAdminStatus()
          Return an integer value representing the smLaunchAdminStatus.
 java.lang.String getAdminStatusString()
          Return a String representing the smLaunchAdminStatus.
 java.lang.String getArgument()
          Return the argument string to be passed to the script launched by this launch button (smLaunchArgument).
 int getControl()
          Return an integer value representing the smLaunchControl value.
 java.lang.String getControlString()
          Return a string representing the smLaunchControl value.
 java.lang.String getError()
          Return the error string (smLaunchError).
 long getExpireTime()
          Return the maximum amount of time in milli seconds that terminated scripts started from this launch button may be retained as valid Run objects (smLaunchExpireTime).
 java.util.Date getLastChange()
          Return the last change time as a Date object (smLaunchLastChange).
 int[] getLastChangeTime()
          Return the last change time as an array of integer values representing the MIB value's octets (smLaunchLastChange).
 long getLifeTime()
          Return the maximum amount of time in milli seconds that scripts started from this launch button may run (smLaunchLifeTime).
 long getMaxCompleted()
          Return the maximum number of terminated scripts started from this launch button and retained as valid Run objects (smLaunchMaxCompleted).
 long getMaxRunning()
          Return the maximum number of running scripts started from this launch button (smLaunchMaxRunning).
 java.lang.String getName()
          Return the name of this Launch object (smLaunchName).
 int getOperStatus()
          Return an integer value representing the smLaunchOperStatus.
 java.lang.String getOperStatusString()
          Return a String representing the smLaunchOperStatus.
 java.lang.String getOwner()
          Return the owner of this Launch object (smScriptOwner).
 long getRowExpireTime()
          Return the launch button's row expire time in milli seconds (smLaunchRowExpireTime).
 int getRowStatus()
          Return an integer value representing the smLaunchRowStatus.
 java.lang.String getRowStatusString()
          Return a String representing the smScriptRowStatus.
 int getRunIndexNext()
          Return an integer value representing the smLaunchRunIndexNext.
 Script getScript()
          Return the Script object that may be started by this Launch object.
 java.lang.String getScriptName()
          Return the script name (smLaunchScriptName).
 java.lang.String getScriptOwner()
          Return the script owner (smLaunchScriptOwner).
 int getStart()
          Return an integer value representing the smLaunchStart value.
 int getStorageType()
          Return an integer value representing the smLaunchStorageType.
 java.lang.String getStorageTypeString()
          Return a String representing the smLaunchStorageType.
 boolean isDisabled()
          Return true, if this script is disabled (smScriptOperStatus == disabled(2)).
 boolean isEnabled()
          Return true, if this script is enabled (smScriptOperStatus == enabled(1)).
 boolean isExpired()
          Return true, if this script is expired (smScriptOperStatus == expired(3)).
 boolean isNonVolatile()
          Return true, if this launch button is stored non-volatile at the agent.
 boolean isPermanent()
          Return true, if this launch button is stored permanently at the agent.
 boolean isReadOnly()
          Return true, if this launch button is stored read-only at the agent.
 boolean isVolatile()
          Return true, if this launch button is stored volatile at the agent.
 void remove()
          Remove this Launch object.
 void setAdminStatus(int status)
          Set the smLaunchAdminStatus represented by an integer value.
 void setArgument(java.lang.String argument)
          Set the argument string to be passed to the script launched by this launch button (smLaunchArgument).
 void setControl(int control)
          Set the smLaunchControl value to a given integer value.
 void setExpireTime(long time)
          Set the maximum amount of time in milli seconds that terminated scripts started from this launch button may be retained as valid Run objects (smLaunchExpireTime).
 void setLifeTime(long time)
          Set the maximum amount of time in milli seconds that scripts started from this launch button may run (smLaunchLifeTime).
 void setMaxCompleted(long max)
          Set the maximum number of terminated scripts started from this launch button and retained as valid Run objects (smLaunchMaxCompleted).
 void setMaxRunning(long max)
          Set the maximum number of running scripts started from this launch button (smLaunchMaxRunning).
 void setNonVolatile()
          Make this launch button stored non-volatile at the agent.
 void setPermanent()
          Make this launch button stored permanently at the agent.
 void setReadOnly()
          Make this launch button stored read-only at the agent.
 void setRowExpireTime(long time)
          Set the launch button's row expire time in milli seconds (smLaunchRowExpireTime).
 void setRowStatus(int status)
          Return an integer value representing the smLaunchRowStatus.
 void setScript(Script script)
          Set the Script object that may be started by this Launch object.
 void setScriptName(java.lang.String scriptname)
          Set the script name (smLaunchScriptName).
 void setScriptOwner(java.lang.String scriptowner)
          Set the script owner (smLaunchScriptOwner).
 void setStart(int runindex)
          Set the smLaunchStart value to a given integer value.
 void setStorageType(int storageType)
          Set the smLaunchStorageType represented by an integer value.
 void setVolatile()
          Make this launch button stored volatile at the agent.
 Run start()
          Start a script from this launch button and return the created Run object.
 Run start(int runindex)
          Start a script with a given run index from this launch button and return the created Run object.
 java.lang.String toString()
          Return a String representation of the launch entry.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

LIFETIME_NEVERENDING

public static final long LIFETIME_NEVERENDING
Special smLifeTime value for never ending scripts.

CONTROL_ABORT

public static final int CONTROL_ABORT
Valid control code

CONTROL_SUSPEND

public static final int CONTROL_SUSPEND
Valid control code

CONTROL_RESUME

public static final int CONTROL_RESUME
Valid control code

CONTROL_NOP

public static final int CONTROL_NOP
Valid control code

controlStrings

public static final java.lang.String[] controlStrings
Array of exit code strings.

ADMIN_STATUS_ENABLED

public static final int ADMIN_STATUS_ENABLED
Valid state

ADMIN_STATUS_DISABLED

public static final int ADMIN_STATUS_DISABLED
Valid state

ADMIN_STATUS_AUTOSTART

public static final int ADMIN_STATUS_AUTOSTART
Valid state

adminStatusStrings

public static final java.lang.String[] adminStatusStrings
Array of admin state strings.

OPER_STATUS_ENABLED

public static final int OPER_STATUS_ENABLED
Valid state

OPER_STATUS_DISABLED

public static final int OPER_STATUS_DISABLED
Valid state

OPER_STATUS_EXPIRED

public static final int OPER_STATUS_EXPIRED
Valid state

operStatusStrings

public static final java.lang.String[] operStatusStrings
Array of operation state strings.

STORAGE_TYPE_OTHER

public static final int STORAGE_TYPE_OTHER
Valid storage type

STORAGE_TYPE_VOLATILE

public static final int STORAGE_TYPE_VOLATILE
Valid storage type

STORAGE_TYPE_NON_VOLATILE

public static final int STORAGE_TYPE_NON_VOLATILE
Valid storage type

STORAGE_TYPE_PERMANENT

public static final int STORAGE_TYPE_PERMANENT
Valid storage type

STORAGE_TYPE_READ_ONLY

public static final int STORAGE_TYPE_READ_ONLY
Valid storage type

storageTypeStrings

public static final java.lang.String[] storageTypeStrings
Array of storage type strings.

ROW_STATUS_ACTIVE

public static final int ROW_STATUS_ACTIVE
Valid row status

ROW_STATUS_NOT_IN_SERVICE

public static final int ROW_STATUS_NOT_IN_SERVICE
Valid row status

ROW_STATUS_NOT_READY

public static final int ROW_STATUS_NOT_READY
Valid row status

ROW_STATUS_CREATE_AND_GO

public static final int ROW_STATUS_CREATE_AND_GO
Valid row status

ROW_STATUS_CREATE_AND_WAIT

public static final int ROW_STATUS_CREATE_AND_WAIT
Valid row status

ROW_STATUS_DESTROY

public static final int ROW_STATUS_DESTROY
Valid row status

rowStatusStrings

public static final java.lang.String[] rowStatusStrings
Array of row status strings.
Constructor Detail

Launch

public Launch(Disman disman,
              java.lang.String owner,
              java.lang.String name)
       throws SnmpException,
              java.io.IOException,
              NoSuchRowException
Create a Launch object for a given Disman object indexed by a given owner and name by retrieval from the agent. Owner strings or script names longer than 32 characters are cut to this length.
Parameters:
disman - the Disman object associated with this launch button
owner - the launch button owner
name - the launch button name
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs
NoSuchRowException - if the indexed row of the launch table cannot be accessed

Launch

public Launch(Disman disman,
              java.lang.String owner,
              java.lang.String name,
              Script script)
       throws SnmpException,
              java.io.IOException,
              IllegalNameException
Create a Launch object for a given Disman object and a given Script object indexed by a given owner and name by creating it at the agent.
Parameters:
disman - the Disman object associated with this launch button
owner - the launch button owner
name - the launch button name
script - the script to be launched by this launch button
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs
IllegalNameException -  
Method Detail

remove

public void remove()
            throws java.io.IOException,
                   SnmpException,
                   TimeoutException
Remove this Launch object. All Run objects associated with this launch button get also aborted and removed implicitly.
Throws:
TimeoutException - if the launch button cannot be disabled in time
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getOwner

public java.lang.String getOwner()
Return the owner of this Launch object (smScriptOwner).
Returns:
the launch button owner

getName

public java.lang.String getName()
Return the name of this Launch object (smLaunchName).
Returns:
the launch button name

getScript

public Script getScript()
                 throws SnmpException,
                        java.io.IOException
Return the Script object that may be started by this Launch object.
Returns:
the script launched by this launch button
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setScript

public void setScript(Script script)
               throws SnmpException,
                      java.io.IOException
Set the Script object that may be started by this Launch object.
Parameters:
script - the script to be launched by this launch button
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getScriptOwner

public java.lang.String getScriptOwner()
                                throws SnmpException,
                                       java.io.IOException
Return the script owner (smLaunchScriptOwner).
Returns:
the owner of the script launched by this launch button
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setScriptOwner

public void setScriptOwner(java.lang.String scriptowner)
                    throws SnmpException,
                           java.io.IOException,
                           IllegalNameException
Set the script owner (smLaunchScriptOwner).
Parameters:
scriptowner - the owner of the script to be launched by this launch button
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs
IllegalNameException -  

getScriptName

public java.lang.String getScriptName()
                               throws SnmpException,
                                      java.io.IOException
Return the script name (smLaunchScriptName).
Returns:
the name of the script launched by this launch button
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setScriptName

public void setScriptName(java.lang.String scriptname)
                   throws SnmpException,
                          java.io.IOException,
                          IllegalNameException
Set the script name (smLaunchScriptName).
Parameters:
scriptname - the name of the script to be launched by this launch button
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs
IllegalNameException -  

getArgument

public java.lang.String getArgument()
                             throws SnmpException,
                                    java.io.IOException
Return the argument string to be passed to the script launched by this launch button (smLaunchArgument).
Returns:
the argument string
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setArgument

public void setArgument(java.lang.String argument)
                 throws SnmpException,
                        java.io.IOException
Set the argument string to be passed to the script launched by this launch button (smLaunchArgument).
Parameters:
argument - the argument string
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getMaxRunning

public long getMaxRunning()
                   throws SnmpException,
                          java.io.IOException
Return the maximum number of running scripts started from this launch button (smLaunchMaxRunning).
Returns:
the maximum number of running scripts
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setMaxRunning

public void setMaxRunning(long max)
                   throws SnmpException,
                          java.io.IOException
Set the maximum number of running scripts started from this launch button (smLaunchMaxRunning).
Parameters:
max - the maximum number of running scripts
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getMaxCompleted

public long getMaxCompleted()
                     throws SnmpException,
                            java.io.IOException
Return the maximum number of terminated scripts started from this launch button and retained as valid Run objects (smLaunchMaxCompleted).
Returns:
the maximum number of completed scripts
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setMaxCompleted

public void setMaxCompleted(long max)
                     throws SnmpException,
                            java.io.IOException
Set the maximum number of terminated scripts started from this launch button and retained as valid Run objects (smLaunchMaxCompleted).
Parameters:
max - the maximum number of completed scripts
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getLifeTime

public long getLifeTime()
                 throws SnmpException,
                        java.io.IOException
Return the maximum amount of time in milli seconds that scripts started from this launch button may run (smLaunchLifeTime).
Returns:
the maximum life time
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setLifeTime

public void setLifeTime(long time)
                 throws SnmpException,
                        java.io.IOException
Set the maximum amount of time in milli seconds that scripts started from this launch button may run (smLaunchLifeTime).
Parameters:
time - the maximum life time
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getExpireTime

public long getExpireTime()
                   throws SnmpException,
                          java.io.IOException
Return the maximum amount of time in milli seconds that terminated scripts started from this launch button may be retained as valid Run objects (smLaunchExpireTime).
Returns:
the expire time
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setExpireTime

public void setExpireTime(long time)
                   throws SnmpException,
                          java.io.IOException
Set the maximum amount of time in milli seconds that terminated scripts started from this launch button may be retained as valid Run objects (smLaunchExpireTime).
Parameters:
time - the expire time
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getStart

public int getStart()
             throws SnmpException,
                    java.io.IOException
Return an integer value representing the smLaunchStart value. This method should not be used by high level Script MIB applications.
Returns:
the smLaunchStart value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setStart

public void setStart(int runindex)
              throws SnmpException,
                     java.io.IOException
Set the smLaunchStart value to a given integer value. This method should not be used by high level Script MIB applications.
Parameters:
runindex - the smLaunchStart value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

start

public Run start(int runindex)
          throws java.io.IOException,
                 SnmpException,
                 TimeoutException
Start a script with a given run index from this launch button and return the created Run object.
Parameters:
runindex - the run index to be used
Returns:
the created Run object
Throws:
TimeoutException - if script initialization cannot be finished in time
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

start

public Run start()
          throws java.io.IOException,
                 SnmpException,
                 TimeoutException
Start a script from this launch button and return the created Run object.
Returns:
the created Run object
Throws:
TimeoutException - if script initialization cannot be finished in time
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

call

public java.lang.String call()
                      throws java.io.IOException,
                             SnmpException,
                             TimeoutException
Start a script from this launch button, block until it has been terminated and return the result string.
Returns:
the result string
Throws:
TimeoutException - if some actions cannot be finished in time
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getControl

public int getControl()
               throws SnmpException,
                      java.io.IOException
Return an integer value representing the smLaunchControl value. This method should not be used by high level Script MIB applications.
Returns:
the smLaunchControl value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getControlString

public java.lang.String getControlString()
                                  throws SnmpException,
                                         java.io.IOException
Return a string representing the smLaunchControl value.
Returns:
the smLaunchControl string
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setControl

public void setControl(int control)
                throws SnmpException,
                       java.io.IOException
Set the smLaunchControl value to a given integer value. This method should not be used by high level Script MIB applications.
Parameters:
control - the smLaunchControl value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getAdminStatus

public int getAdminStatus()
                   throws SnmpException,
                          java.io.IOException
Return an integer value representing the smLaunchAdminStatus. This method should not be used by high level Script MIB applications.
Returns:
the smLaunchAdminStatus value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getAdminStatusString

public java.lang.String getAdminStatusString()
                                      throws SnmpException,
                                             java.io.IOException
Return a String representing the smLaunchAdminStatus.
Returns:
the smLaunchAdminStatus string
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setAdminStatus

public void setAdminStatus(int status)
                    throws SnmpException,
                           java.io.IOException
Set the smLaunchAdminStatus represented by an integer value. This method should not be used by high level Script MIB applications.
Parameters:
status - the smLaunchAdminStatus value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getOperStatus

public int getOperStatus()
                  throws SnmpException,
                         java.io.IOException
Return an integer value representing the smLaunchOperStatus. This method should not be used by high level Script MIB applications.
Returns:
the smScriptOperStatus value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getOperStatusString

public java.lang.String getOperStatusString()
                                     throws SnmpException,
                                            java.io.IOException
Return a String representing the smLaunchOperStatus.
Returns:
the smScriptOperStatus string
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

isEnabled

public boolean isEnabled()
                  throws SnmpException,
                         java.io.IOException
Return true, if this script is enabled (smScriptOperStatus == enabled(1)).
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

isDisabled

public boolean isDisabled()
                   throws SnmpException,
                          java.io.IOException
Return true, if this script is disabled (smScriptOperStatus == disabled(2)).
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

isExpired

public boolean isExpired()
                  throws SnmpException,
                         java.io.IOException
Return true, if this script is expired (smScriptOperStatus == expired(3)).
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

enable

public void enable()
            throws java.io.IOException,
                   SnmpException,
                   TimeoutException
Enable this launch button. Wait synchronously until the agent confirmed that the launch button is enabled. Otherwise, a TimeoutException will be thrown.
Throws:
TimeoutException - if enabling cannot be finished in time
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

disable

public void disable()
             throws java.io.IOException,
                    SnmpException,
                    TimeoutException
Disable the launch button. Wait synchronously until the agent confirmed that the launch button is disabled.
Throws:
TimeoutException - if disabling cannot be finished in time
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getRunIndexNext

public int getRunIndexNext()
                    throws SnmpException,
                           java.io.IOException
Return an integer value representing the smLaunchRunIndexNext. This method should not be used by high level Script MIB applications.
Returns:
the smLaunchRunIndexNext value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getStorageType

public int getStorageType()
                   throws SnmpException,
                          java.io.IOException
Return an integer value representing the smLaunchStorageType. This method should not be used by high level Script MIB applications.
Returns:
the smLaunchStorageType value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getStorageTypeString

public java.lang.String getStorageTypeString()
                                      throws SnmpException,
                                             java.io.IOException
Return a String representing the smLaunchStorageType.
Returns:
the smLaunchStorageType string
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

isVolatile

public boolean isVolatile()
                   throws SnmpException,
                          java.io.IOException
Return true, if this launch button is stored volatile at the agent. (smLaunchStorageType == volatile(2)).
Returns:
true, if launch button is volatile
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

isNonVolatile

public boolean isNonVolatile()
                      throws SnmpException,
                             java.io.IOException
Return true, if this launch button is stored non-volatile at the agent. (smLaunchStorageType == nonVolatile(3)).
Returns:
true, if launch button is volatile
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

isPermanent

public boolean isPermanent()
                    throws SnmpException,
                           java.io.IOException
Return true, if this launch button is stored permanently at the agent. (smLaunchStorageType == permanent(4)).
Returns:
true, if launch button is permanent
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

isReadOnly

public boolean isReadOnly()
                   throws SnmpException,
                          java.io.IOException
Return true, if this launch button is stored read-only at the agent. (smLaunchStorageType == readOnly(5)).
Returns:
true, if launch button is read-only
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setStorageType

public void setStorageType(int storageType)
                    throws SnmpException,
                           java.io.IOException
Set the smLaunchStorageType represented by an integer value. This method should not be used by high level Script MIB applications.
Parameters:
storageType - the smLaunchStorageType value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setVolatile

public void setVolatile()
                 throws SnmpException,
                        java.io.IOException
Make this launch button stored volatile at the agent. (smLaunchStorageType == volatile(2)).
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setNonVolatile

public void setNonVolatile()
                    throws SnmpException,
                           java.io.IOException
Make this launch button stored non-volatile at the agent. (smLaunchStorageType == nonVolatile(3)).
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setPermanent

public void setPermanent()
                  throws SnmpException,
                         java.io.IOException
Make this launch button stored permanently at the agent. (smLaunchStorageType == permanent(4)).
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setReadOnly

public void setReadOnly()
                 throws SnmpException,
                        java.io.IOException
Make this launch button stored read-only at the agent. (smLaunchStorageType == readOnly(5)).
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getRowStatus

public int getRowStatus()
                 throws SnmpException,
                        java.io.IOException
Return an integer value representing the smLaunchRowStatus. This method should not be used by high level Script MIB applications.
Returns:
the smLaunchRowStatus value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getRowStatusString

public java.lang.String getRowStatusString()
                                    throws SnmpException,
                                           java.io.IOException
Return a String representing the smScriptRowStatus.
Returns:
the script's smScriptRowStatus string
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setRowStatus

public void setRowStatus(int status)
                  throws SnmpException,
                         java.io.IOException
Return an integer value representing the smLaunchRowStatus. This method should not be used by high level Script MIB applications.
Parameters:
status - the smLaunchRowStatus value
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getError

public java.lang.String getError()
                          throws java.io.IOException,
                                 SnmpException,
                                 DismanReadException
Return the error string (smLaunchError).
Returns:
the error string
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getLastChangeTime

public int[] getLastChangeTime()
                        throws java.io.IOException,
                               SnmpException
Return the last change time as an array of integer values representing the MIB value's octets (smLaunchLastChange). This method should not be used by high level Script MIB applications.
Returns:
the array of octets of the smLaunchLastChange
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getLastChange

public java.util.Date getLastChange()
                             throws java.io.IOException,
                                    SnmpException
Return the last change time as a Date object (smLaunchLastChange).
Returns:
Date object representing the launch buttons's last change time, or null if it has not yet been modified.
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

getRowExpireTime

public long getRowExpireTime()
                      throws java.io.IOException,
                             SnmpException
Return the launch button's row expire time in milli seconds (smLaunchRowExpireTime).
Returns:
the row expire time in milli seconds
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

setRowExpireTime

public void setRowExpireTime(long time)
                      throws java.io.IOException,
                             SnmpException
Set the launch button's row expire time in milli seconds (smLaunchRowExpireTime).
Throws:
SnmpException - if an Snmp request fails
java.io.IOException - if a local I/O problem occurs

toString

public java.lang.String toString()
Return a String representation of the launch entry. Overrides java.lang.Object.
Overrides:
toString in class java.lang.Object