com.rocketsoftware.mvapi
Class MVSubroutine

java.lang.Object
  extended by com.rocketsoftware.mvapi.MVSubroutine

public class MVSubroutine
extends java.lang.Object

Encapsulates a subroutine.


Constructor Summary
MVSubroutine(MVConnector connector, java.lang.String subName, int arguments)
          Constructs the object with a mvSub name and argument count.
 
Method Summary
 java.lang.String getArg(int argument)
          Retrieves an argument's value.
 java.lang.String getName()
          Gets the mvSub name.
 void mvCall()
          Calls the mvSub.
 void setArg(int argument, java.lang.String value)
          Assigns a value to a mvSub argument.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MVSubroutine

public MVSubroutine(MVConnector connector,
                    java.lang.String subName,
                    int arguments)
Constructs the object with a mvSub name and argument count.

Parameters:
subName - name of the mvSub
arguments - number of arguments
Method Detail

setArg

public void setArg(int argument,
                   java.lang.String value)
Assigns a value to a mvSub argument.

Parameters:
argument - argument number
value - argument value

getArg

public java.lang.String getArg(int argument)
Retrieves an argument's value.

Parameters:
argument - argument number
Returns:
argument value

getName

public java.lang.String getName()
Gets the mvSub name.

Returns:
mvSub name

mvCall

public void mvCall()
            throws MVException
Calls the mvSub. Note: Only named common blocks are supported in subroutines called from this API.

Throws:
MVException