Interface ISystemParameter
-
- All Superinterfaces:
ICICSObject,ICICSResource,com.ibm.cics.model.meta.ITypedObject
public interface ISystemParameter extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classISystemParameter.SourceValueEnumeration type for field SOURCEstatic classISystemParameter.TypeValueEnumeration type for field TYPE
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ISystemParameterReferencegetCICSObjectReference()java.lang.StringgetKeyword()Getter for field KEYWORDICICSType<ISystemParameter>getObjectType()java.lang.LonggetSegnum()Getter for field SEGNUMjava.lang.LonggetSegtot()Getter for field SEGTOTISystemParameter.SourceValuegetSource()Getter for field SOURCEjava.lang.LonggetTotallen()Getter for field TOTALLENISystemParameter.TypeValuegetType()Getter for field TYPEjava.lang.StringgetValue()Getter for field VALUEjava.lang.LonggetValuelen()Getter for field VALUELEN-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ISystemParameter> getObjectType()
- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getKeyword
java.lang.String getKeyword()
Getter for field KEYWORDKeyword name
The 16 character keyword identifier of the system parameter.
-
getType
ISystemParameter.TypeValue getType()
Getter for field TYPEType of system parameter
Identifies the type of system parameter that has been extracted. The only value supported is:
- SIT - The system initialization parameter can be extracted from any of the following
locations:
- the DFHSITxx load module (TABLE)
- overrides specified on the PARM parameter of the EXEC PGM=DFHSIP statement (JCL)
- overrides specified in the SYSIN data set of the CICS startup job stream (SYSIN)
- overrides specified on the system console (CONSOLE)
- SIT - The system initialization parameter can be extracted from any of the following
locations:
-
getSource
ISystemParameter.SourceValue getSource()
Getter for field SOURCESource of system parameter
Identifies the source location of the system parameter that has been extracted. Values are:
- TABLE - The parameter was extracted from the DFHSITxx load module.
- CONSOLE - The parameter was extracted from an override provided through the system console.
- SYSIN - The parameter was extracted from an override provided through a SYSIN data set.
- JCL - The parameter was extracted from an override provided through a JCL EXEC statement parameter.
-
getValuelen
java.lang.Long getValuelen()
Getter for field VALUELENKeyword value length
The length of the current keyword value segment. If there is only one keyword value segment then this will be the same value as the total value length.
-
getSegnum
java.lang.Long getSegnum()
Getter for field SEGNUMRecord segment number
The segment number of returned value.
-
getSegtot
java.lang.Long getSegtot()
Getter for field SEGTOTTotal segment number
The total number of segments for value.
-
getTotallen
java.lang.Long getTotallen()
Getter for field TOTALLENTotal value length
The combined length of all the current keyword value segments added together. If there is only one keyword value segment for the current keyword, then this will be the same value as the keyword value length.
-
getValue
java.lang.String getValue()
Getter for field VALUEKeyword value
The value assigned to the associated keyword from the associated table type from the associated source location.
-
getCICSObjectReference
ISystemParameterReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICICSResource
-
-