com.ibm.cics.model
Interface ISystemParameter

All Superinterfaces:
ICICSObject, ICICSResource, com.ibm.cics.model.meta.ITypedObject

public interface ISystemParameter
extends ICICSResource

generated from CICS resourcetable SYSPARM


Nested Class Summary
static class ISystemParameter.SourceValue
          Enumeration type for field SOURCE
static class ISystemParameter.TypeValue
          Enumeration type for field TYPE
 
Method Summary
 java.lang.String getKeyword()
          Getter for field KEYWORD
 java.lang.Long getSegnum()
          Getter for field SEGNUM
 java.lang.Long getSegtot()
          Getter for field SEGTOT
 ISystemParameter.SourceValue getSource()
          Getter for field SOURCE
 java.lang.Long getTotallen()
          Getter for field TOTALLEN
 ISystemParameter.TypeValue getType()
          Getter for field TYPE
 java.lang.String getValue()
          Getter for field VALUE
 java.lang.Long getValuelen()
          Getter for field VALUELEN
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName, getObjectType
 

Method Detail

getKeyword

java.lang.String getKeyword()
Getter for field KEYWORD

Keyword name

The 16 character keyword identifier of the system parameter.


getType

ISystemParameter.TypeValue getType()
Getter for field TYPE

Type of system parameter

Identifies the type of system parameter that has been extracted. The only value supported is:


getSource

ISystemParameter.SourceValue getSource()
Getter for field SOURCE

Source of system parameter

Identifies the source location of the system parameter that has been extracted. Values are:

Note: CONSOLE will not retrieve parameters that have been entered to correct any invalid values. You should correct these values at their source locations to enable CICS to start without operator intervention.


getValuelen

java.lang.Long getValuelen()
Getter for field VALUELEN

Keyword 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 SEGNUM

Record segment number

The segment number of returned value.


getSegtot

java.lang.Long getSegtot()
Getter for field SEGTOT

Total segment number

The total number of segments for value.


getTotallen

java.lang.Long getTotallen()
Getter for field TOTALLEN

Total 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 VALUE

Keyword value

The value assigned to the associated keyword from the associated table type from the associated source location.



Copyright 2008-2009 IBM Corp. All Rights Reserved.