All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class asjava.uniobjects.UniSubroutine

java.lang.Object
   |
   +----asjava.uniobjects.UniBase
           |
           +----asjava.uniobjects.UniSubroutine

public class UniSubroutine
extends UniBase
UniSubroutine is the object type used to allow the user to run a cataloged BASIC subroutine on the server.

Version:
Version 1.0
Author:
David T. Meeks

Method Index

 o call()
Executes the catalogued UniVerse subroutine identified during the UniSubroutine creation.
 o getArg(int)
retrieves the the contents of the subroutine arguments after a successful call has been executed
 o getNumArgs()
Returns the number of arguments set for this subroutine
 o getRoutineName()
Retrieves the routine name established during the object creation
 o resetArgs()
resets the output argument array back to all empty values.
 o setArg(int, Object)
sets up the input argument array to be used for the catalogued subroutine call
 o setNumArgs(int)
sets up the number of input arguments to be used for this catalogued subroutine call
 o setRoutineName(Object)
sets up the name of the subroutine to be called on the server.

Methods

 o call
 public void call() throws UniSubroutineException
Executes the catalogued UniVerse subroutine identified during the UniSubroutine creation. Uses the arguments established with the setArg method.

Throws: UniSubroutineException
if a server error occurs
See Also:
setArg
 o getArg
 public String getArg(int aArgNum) throws UniSubroutineException
retrieves the the contents of the subroutine arguments after a successful call has been executed

Parameters:
aArgNum - integer value of the argument to be retrieved. 0 based, first argument is 0.
Returns:
String value representing the subroutine argument requested
Throws: UniSubroutineException
if an invalid argument value is passed in
See Also:
setArg
 o getNumArgs
 public int getNumArgs()
Returns the number of arguments set for this subroutine

Returns:
integer value representing the number of argument set up for this subrouting
See Also:
setNumArgs
 o getRoutineName
 public String getRoutineName()
Retrieves the routine name established during the object creation

Returns:
String value representing the name of the server-side BASIC routine to execute
See Also:
setRoutineName
 o resetArgs
 public void resetArgs()
resets the output argument array back to all empty values.

 o setArg
 public void setArg(int aArgNum,
                    Object aArgVal) throws UniSubroutineException
sets up the input argument array to be used for the catalogued subroutine call

Parameters:
aArgNum - integer representing which argument value is to be set. 0 represents the first argument
aArgVal - String representing the value to set this argument to
Throws: UniSubroutineException
is thrown if the argument number is invalid
See Also:
getArg
 o setNumArgs
 public void setNumArgs(int aNumArgs) throws UniSubroutineException
sets up the number of input arguments to be used for this catalogued subroutine call

Parameters:
aNumArgs - integer representing the number of arguments this subroutine uses
Throws: UniSubroutineException
is thrown if the argument number if invalid
See Also:
getNumArgs
 o setRoutineName
 public void setRoutineName(Object aRoutineName)
sets up the name of the subroutine to be called on the server.

Parameters:
aRoutineName - String representing the name of the catalogued BASIC subroutine to be called on the server
See Also:
getRoutineName

All Packages  Class Hierarchy  This Package  Previous  Next  Index