Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.edit.generator.model
Class RPGProcedureParameter

java.lang.Object
  extended by com.ibm.etools.iseries.edit.generator.model.RPGCommon
      extended by com.ibm.etools.iseries.edit.generator.model.RPGProcedureParameter

public class RPGProcedureParameter
extends RPGCommon


Field Summary
static String Copyright
           
protected  RPGFieldType fieldType
           
protected  Vector keywords
           
protected  boolean nullind
           
protected  boolean nullTerminatedString
           
protected  boolean optionalNoPass
           
protected  boolean optionalOmit
           
protected  boolean passByReference
           
protected  boolean passByValue
           
protected  boolean rightAdjustedString
           
protected  boolean trim
           
protected  boolean varSize
           
 
Fields inherited from class com.ibm.etools.iseries.edit.generator.model.RPGCommon
fieldName, purpose
 
Constructor Summary
RPGProcedureParameter()
           
 
Method Summary
 RPGFieldType getFieldType()
           
 Vector getKeywords()
           
 boolean isNullind()
           
 boolean isNullTerminatedString()
           
 boolean isOptionalNoPass()
           
 boolean isOptionalOmit()
           
 boolean isPassByReference()
           
 boolean isPassByValue()
           
 boolean isRightAdjustedString()
           
 boolean isTrim()
           
 boolean isVarSize()
           
 void setFieldType(RPGFieldType type)
           
 void setKeywords(Vector vector)
           
 void setNullind(boolean b)
           
 void setNullTerminatedString(boolean b)
          Sets whether non-reference pointer parameters are null terminated (*STRING); useful when passing actual character literals.
 void setOptionalNoPass(boolean b)
          Sets whether the caller can choose not to pass anything for optional parameters that are not needed (*NOPASS).
 void setOptionalOmit(boolean b)
          Sets whether the caller must specify *OMIT for non-supplied parameter values.
 void setPassByReference()
          Sets this parameter to pass by Reference.
 void setPassByReference(boolean b)
           
 void setPassByValue()
          Sets this parameter to pass by Value.
 void setPassByValue(boolean b)
           
 void setRightAdjustedString(boolean b)
          Sets whether character or graphic fields will be right adjusted when passed (*RIGHTADJ)
 void setTrim(boolean b)
           
 void setVarSize(boolean b)
          Sets whether arrays or character fields allow various actual lengths to be passed (*VARSIZE)
 
Methods inherited from class com.ibm.etools.iseries.edit.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

Copyright

public static final String Copyright
See Also:
Constant Field Values

fieldType

protected RPGFieldType fieldType

keywords

protected Vector keywords

passByReference

protected boolean passByReference

passByValue

protected boolean passByValue

optionalNoPass

protected boolean optionalNoPass

optionalOmit

protected boolean optionalOmit

varSize

protected boolean varSize

nullTerminatedString

protected boolean nullTerminatedString

rightAdjustedString

protected boolean rightAdjustedString

trim

protected boolean trim

nullind

protected boolean nullind
Constructor Detail

RPGProcedureParameter

public RPGProcedureParameter()
Method Detail

isNullTerminatedString

public boolean isNullTerminatedString()
Returns:
Whether non-reference pointer parameters are null terminated (*STRING); useful when passing actual character literals.
See Also:
setNullTerminatedString(boolean)

isOptionalNoPass

public boolean isOptionalNoPass()
Returns:
Whether the caller can choose not to pass anything for optional parameters that are not needed (*NOPASS).
See Also:
setOptionalNoPass(boolean)

isOptionalOmit

public boolean isOptionalOmit()
Returns:
Whether the caller must specify *OMIT for non-supplied parameter values.
See Also:
setOptionalOmit(boolean)

isPassByReference

public boolean isPassByReference()
Returns:
Whether this parameter is passed by reference. Any changes made to the parameter inside the procedure have persist on the contents of the actual field passed in.
See Also:
setPassByReference()

isPassByValue

public boolean isPassByValue()
Returns:
Whether this parameter is passed by value. Any changes made to the parameter inside the procedure have no effect on the contents of the actual field passed in.
See Also:
setPassByValue()

isRightAdjustedString

public boolean isRightAdjustedString()
Returns:
Whether character or graphic fields will be right adjusted when passed (*RIGHTADJ)
See Also:
setRightAdjustedString(boolean)

isVarSize

public boolean isVarSize()
Returns:
Whether arrays or character fields allow various actual lengths to be passed (*VARSIZE)
See Also:
setVarSize(boolean)

setNullTerminatedString

public void setNullTerminatedString(boolean b)
Sets whether non-reference pointer parameters are null terminated (*STRING); useful when passing actual character literals.

Parameters:
b - is true if and only if non-reference pointer parameters are null-terminated.
See Also:
isNullTerminatedString()

setOptionalNoPass

public void setOptionalNoPass(boolean b)
Sets whether the caller can choose not to pass anything for optional parameters that are not needed (*NOPASS).

Parameters:
b - is true if and only if the caller can choose not to pass anything for optional parameters
See Also:
isOptionalNoPass()

setOptionalOmit

public void setOptionalOmit(boolean b)
Sets whether the caller must specify *OMIT for non-supplied parameter values.

Parameters:
b - is true if and only if the caller must specify *OMIT
See Also:
isOptionalOmit()

setPassByReference

public void setPassByReference()
Sets this parameter to pass by Reference. Any changes made to the parameter inside the procedure have persist on the contents of the actual field passed in.

See Also:
isPassByReference()

setPassByValue

public void setPassByValue()
Sets this parameter to pass by Value. Any changes made to the parameter inside the procedure have no effect on the contents of the actual field passed in.

See Also:
isPassByValue()

setRightAdjustedString

public void setRightAdjustedString(boolean b)
Sets whether character or graphic fields will be right adjusted when passed (*RIGHTADJ)

Parameters:
b - is true if and only if fields of the appropriate type will be right adjusted when passed
See Also:
isRightAdjustedString()

setVarSize

public void setVarSize(boolean b)
Sets whether arrays or character fields allow various actual lengths to be passed (*VARSIZE)

Parameters:
b - is true if and only if arrays and char fields allow actual lengths to be passed
See Also:
isVarSize()

getFieldType

public RPGFieldType getFieldType()
Returns:

setFieldType

public void setFieldType(RPGFieldType type)
Parameters:
type -

getKeywords

public Vector getKeywords()
Returns:

setKeywords

public void setKeywords(Vector vector)
Parameters:
vector -

setPassByReference

public void setPassByReference(boolean b)
Parameters:
b -

setPassByValue

public void setPassByValue(boolean b)
Parameters:
b -

isTrim

public boolean isTrim()
Returns:

setTrim

public void setTrim(boolean b)
Parameters:
b -

setNullind

public void setNullind(boolean b)
Parameters:
b - V5R4 addition

isNullind

public boolean isNullind()
Parameters:
b - V5R4 addition

Rational Developer for Power Systems Software
V7.6

Copyright 2011 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.