iSeries Remote Systems
v6.0.1

com.ibm.etools.iseries.editor.generator.model
Class ProcDef

java.lang.Object
  extended bycom.ibm.etools.iseries.editor.generator.model.RPGCommon
      extended bycom.ibm.etools.iseries.editor.generator.model.ProcDef

public class ProcDef
extends RPGCommon


Field Summary
protected  boolean export
           
protected  String externalName
           
protected  boolean hasRetVal
           
protected  Vector parameters
           
protected  RetVal retval
           
 
Fields inherited from class com.ibm.etools.iseries.editor.generator.model.RPGCommon
fieldName, purpose
 
Constructor Summary
ProcDef()
           
 
Method Summary
 void addParameter(Parameter param)
          Adds another new Parameter to the list of Parameters for this procedure definition.
 void createReturnValue()
          Creates a new RetVal object and associates it with this ProcDef.
 String getExternalName()
           
 Parameter getParameter(int i)
           
 Vector getParameters()
           
 RetVal getReturnValue()
           
 boolean hasReturnValue()
           
 boolean isExportable()
           
 void removeParameter(int i)
          Removes the i'th (0 based) Parameter in the list of Parameters.
 void removeParameter(Parameter param)
          Removes param from the list of Parameters.
 void setExportable(boolean b)
          Sets whether or not this procedure is exportable for use by other code (EXPORT).
 void setExternalName(String name)
          Sets the name of this procedure given to other external procedures (EXTPROC).
 void setHasReturnValue(boolean b)
          Sets whether this procedure returns a value.
 void setParameters(Vector parametersList)
          Sets the Parameters of this procedure to be parametersList.
 void setReturnValue(RetVal val)
          Sets the return value of this procedure to be val, if this procedure is set to return a value, otherwise, has no effect.
 void swapParameters(int i, int j)
          Swaps the i'th and j'th Parameters in the list of Parameters.
 
Methods inherited from class com.ibm.etools.iseries.editor.generator.model.RPGCommon
getMessages, getName, getPurpose, isValid, setFieldName, setPurpose
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

externalName

protected String externalName

export

protected boolean export

hasRetVal

protected boolean hasRetVal

retval

protected RetVal retval

parameters

protected Vector parameters
Constructor Detail

ProcDef

public ProcDef()
Method Detail

isExportable

public boolean isExportable()
Returns:
Whether or not this procedure is exportable for use by other code (EXPORT).
See Also:
setExportable(boolean)

getExternalName

public String getExternalName()
Returns:
The name of this procedure given to other external procedures (EXTPROC).
See Also:
setExternalName(String)

getParameters

public Vector getParameters()
Returns:
The set of Parameters of this procedure.
See Also:
addParameter(Parameter), getParameter(int), removeParameter(int), removeParameter(Parameter), swapParameters(int, int)

getParameter

public Parameter getParameter(int i)
Parameters:
i - the (0 based) index of the Parameter to be returned
Returns:
The i'th Parameter in the set of Parameters.
See Also:
getParameters(), addParameter(Parameter), removeParameter(int), removeParameter(Parameter), swapParameters(int, int)

hasReturnValue

public boolean hasReturnValue()
Returns:
Whether or not this procedure definition returns a value.
See Also:
createReturnValue(), getReturnValue(), setReturnValue(RetVal), setHasReturnValue(boolean)

createReturnValue

public void createReturnValue()
Creates a new RetVal object and associates it with this ProcDef.

See Also:
hasReturnValue(), getReturnValue(), setReturnValue(RetVal), setHasReturnValue(boolean)

getReturnValue

public RetVal getReturnValue()
Returns:
The return value of this procedure definition, if it is set to have one, null otherwise.
See Also:
hasReturnValue(), createReturnValue(), setReturnValue(RetVal), setHasReturnValue(boolean)

setExportable

public void setExportable(boolean b)
Sets whether or not this procedure is exportable for use by other code (EXPORT).

Parameters:
b - is true if and only if this procedure is exportable
See Also:
isExportable()

setExternalName

public void setExternalName(String name)
Sets the name of this procedure given to other external procedures (EXTPROC).

Parameters:
name - the external name of this procedure
See Also:
getExternalName()

setParameters

public void setParameters(Vector parametersList)
Sets the Parameters of this procedure to be parametersList.

Parameters:
parametersList - a Vector containing the Paramaters of this procedure.

setHasReturnValue

public void setHasReturnValue(boolean b)
Sets whether this procedure returns a value.

Parameters:
b - is true if and only if this ProcDef returns a value.
See Also:
createReturnValue(), getReturnValue(), setReturnValue(RetVal), hasReturnValue()

setReturnValue

public void setReturnValue(RetVal val)
Sets the return value of this procedure to be val, if this procedure is set to return a value, otherwise, has no effect.

Parameters:
val - the new return value of this procedure
See Also:
hasReturnValue(), createReturnValue(), getReturnValue(), setHasReturnValue(boolean)

addParameter

public void addParameter(Parameter param)
Adds another new Parameter to the list of Parameters for this procedure definition.

Parameters:
param - the Parameter to add
See Also:
getParameter(int), getParameters(), removeParameter(Parameter), removeParameter(int), swapParameters(int, int)

removeParameter

public void removeParameter(Parameter param)
Removes param from the list of Parameters.

Parameters:
param - the Parameter to remove
See Also:
getParameter(int), getParameters(), addParameter(Parameter), removeParameter(int), swapParameters(int, int)

removeParameter

public void removeParameter(int i)
Removes the i'th (0 based) Parameter in the list of Parameters.

Parameters:
i - the index of the Parameter to remove
See Also:
getParameter(int), getParameters(), addParameter(Parameter), removeParameter(Parameter), swapParameters(int, int)

swapParameters

public void swapParameters(int i,
                           int j)
Swaps the i'th and j'th Parameters in the list of Parameters.

Parameters:
i - the index of the Parameter to swap with the j'th Parameter.
j - the index of the Parameter to swap with the i'th Parameter.

iSeries Remote Systems
v6.0.1

Copyright © 2005 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.