|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectasjava.uniobjects.UniBase
asjava.uniobjects.UniSubroutine
UniSubroutine
is the object type used to allow the user to run a cataloged
BASIC subroutine on the server.
Field Summary |
---|
Fields inherited from class asjava.uniobjects.UniBase |
---|
inPacket, outPacket, uniConnection, uniEncryptionType, uniParentSession, uniStatus |
Method Summary | |
---|---|
void |
call()
Executes the catalogued UniVerse subroutine identified during the UniSubroutine
creation. |
java.lang.String |
getArg(int aArgNum)
retrieves the the contents of the subroutine arguments after a successful call has
been executed |
int |
getNumArgs()
Returns the number of arguments set for this subroutine |
java.lang.String |
getRoutineName()
Retrieves the routine name established during the object creation |
void |
resetArgs()
resets the output argument array back to all empty values. |
void |
setArg(int aArgNum,
java.lang.Object aArgVal)
sets up the input argument array to be used for the catalogued subroutine call |
void |
setNumArgs(int aNumArgs)
sets up the number of input arguments to be used for this catalogued subroutine call |
void |
setRoutineName(java.lang.Object aRoutineName)
sets up the name of the subroutine to be called on the server. |
Methods inherited from class asjava.uniobjects.UniBase |
---|
getEncryptionType, isCommandActive, setEncryptionType, status |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
public void call() throws UniSubroutineException
UniSubroutine
creation. Uses the arguments established with the setArg
method.
UniSubroutineException
- if a server error occurssetArg(int, java.lang.Object)
public java.lang.String getArg(int aArgNum) throws UniSubroutineException
call
has
been executed
aArgNum
- integer value of the argument to be retrieved. 0 based, first argument is 0.
UniSubroutineException
- if an invalid argument value is passed insetArg(int, java.lang.Object)
public int getNumArgs()
setNumArgs(int)
public java.lang.String getRoutineName()
setRoutineName(java.lang.Object)
public void resetArgs()
public void setArg(int aArgNum, java.lang.Object aArgVal) throws UniSubroutineException
aArgNum
- integer representing which argument value is to be set. 0 represents the first argumentaArgVal
- String representing the value to set this argument to
UniSubroutineException
- is thrown if the argument number is invalidgetArg(int)
public void setNumArgs(int aNumArgs) throws UniSubroutineException
aNumArgs
- integer representing the number of arguments this subroutine uses
UniSubroutineException
- is thrown if the argument number if invalidgetNumArgs()
public void setRoutineName(java.lang.Object aRoutineName)
aRoutineName
- String representing the name of the catalogued BASIC subroutine to be called on the servergetRoutineName()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |