iSeries Remote Systems
v6.0.0

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

java.lang.Object
  extended bycom.ibm.etools.iseries.editor.generator.model.RPGCommon
      extended bycom.ibm.etools.iseries.editor.generator.model.RPGFieldType
          extended bycom.ibm.etools.iseries.editor.generator.model.Parameter
All Implemented Interfaces:
IDSpec

public class Parameter
extends RPGFieldType


Field Summary
protected  boolean nullTerminatedString
           
protected  boolean optionalNoPass
           
protected  boolean optionalOmit
           
protected  boolean passByConstantReference
           
protected  boolean passByReference
           
protected  boolean passByValue
           
protected  boolean rightAdjustedString
           
protected  boolean varSize
           
 
Fields inherited from class com.ibm.etools.iseries.editor.generator.model.RPGFieldType
array, arrayField, arraySize, ccsidNbr, className, Copyright, dataType, dateFormat, decimals, fmtString, from, isDecimalAllowed, isLengthAllowed, keywords, length, likeAnother, likeKeyword, otherField, packeven, procPointer, sample, separator, timeFormat, to, typeChar, typeIndex
 
Fields inherited from class com.ibm.etools.iseries.editor.generator.model.RPGCommon
fieldName, purpose
 
Fields inherited from interface com.ibm.etools.iseries.editor.generator.model.IDSpec
DATEFMT_DMY, DATEFMT_EUR, DATEFMT_ISO, DATEFMT_JIS, DATEFMT_JUL, DATEFMT_MDY, DATEFMT_NONE, DATEFMT_USA, DATEFMT_YMD, DT_AMPERSAND, DT_COLON, DT_COMMA, DT_DASH, DT_NONE, DT_PERIOD, DT_SLASH, INFDS_DB, INFDS_DSPF_ATTR, INFDS_DSPF_DEV, INFDS_FILE, INFDS_ICF_ATTR, INFDS_ICF_DEV, INFDS_IO, INFDS_OPEN, INFDS_PRTF, MSG_ERR_REQ_FIELD, RPGARRAYKWD_B, RPGARRAYKWD_F, RPGARRAYKWD_I, RPGARRAYKWD_L, RPGARRAYKWD_P, RPGARRAYKWD_R, RPGARRAYKWD_S, RPGARRAYKWD_U, RPGTYPE_A, RPGTYPE_AV, RPGTYPE_B, RPGTYPE_C, RPGTYPE_CV, RPGTYPE_D, RPGTYPE_F, RPGTYPE_G, RPGTYPE_GV, RPGTYPE_I, RPGTYPE_I2, RPGTYPE_N, RPGTYPE_P, RPGTYPE_S, RPGTYPE_STAR, RPGTYPE_T, RPGTYPE_U, RPGTYPE_U2, RPGTYPE_Z, TIMEFMT_EUR, TIMEFMT_HMS, TIMEFMT_ISO, TIMEFMT_JIS, TIMEFMT_NONE, TIMEFMT_USA
 
Constructor Summary
Parameter()
           
 
Method Summary
 boolean isNullTerminatedString()
           
 boolean isOptionalNoPass()
           
 boolean isOptionalOmit()
           
 boolean isPassByConstantReference()
           
 boolean isPassByReference()
           
 boolean isPassByValue()
           
 boolean isRightAdjustedString()
           
 boolean isVarSize()
           
 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 setPassByConstantReference()
          Sets this parameter to pass by Constant Reference.
 void setPassByReference()
          Sets this parameter to pass by Reference.
 void setPassByValue()
          Sets this parameter to pass by Value.
 void setRightAdjustedString(boolean b)
          Sets whether character or graphic fields will be right adjusted when passed (*RIGHTADJ)
 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.editor.generator.model.RPGFieldType
createNewArray, getArray, getArraySize, getCcsidNbr, getClassName, getDataType, getDateFormat, getDecimals, getFieldTypeKeywords, getFmtString, getFrom, getKeywords, getLength, getLikeKeyword, getOtherField, getSample, getSeparator, getTimeFormat, getTo, getTypeChar, getTypeIndex, isArray, isDecimalAllowed, isLengthAllowed, isLikeAnother, isPackeven, isProcPointer, setArray, setArraySize, setCcsidNbr, setClassName, setDataType, setDateFormat, setDecimalAllowed, setDecimals, setFmtString, setFrom, setKeywords, setLength, setLengthAllowed, setLikeAnother, setLikeKeyword, setOtherField, setPackeven, setProcPointer, setSample, setSeparator, setTimeFormat, setTo, setTypeChar, setTypeIndex
 
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

passByReference

protected boolean passByReference

passByValue

protected boolean passByValue

passByConstantReference

protected boolean passByConstantReference

optionalNoPass

protected boolean optionalNoPass

optionalOmit

protected boolean optionalOmit

varSize

protected boolean varSize

nullTerminatedString

protected boolean nullTerminatedString

rightAdjustedString

protected boolean rightAdjustedString
Constructor Detail

Parameter

public Parameter()
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)

isPassByConstantReference

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

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()

setPassByConstantReference

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

See Also:
isPassByConstantReference()

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()

iSeries Remote Systems
v6.0.0

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.