com.ibm.cics.model
Interface ICaptureSpecificationData

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

public interface ICaptureSpecificationData
extends ICICSResource

generated from CICS resourcetable EVCSDATA


Nested Class Summary
static class ICaptureSpecificationData.OperatorValue
          Enumeration type for field OPERATOR
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,ICaptureSpecificationData> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 java.lang.String getCapturespec()
          Getter for field CAPTURESPEC
 ICaptureSpecificationDataReference getCICSObjectReference()
           
 java.lang.String getContainer()
          Getter for field CONTAINER
 java.lang.String getEventbinding()
          Getter for field EVENTBINDING
 java.lang.Long getFieldlength()
          Getter for field FIELDLENGTH
 java.lang.Long getFieldoffset()
          Getter for field FIELDOFFSET
 java.lang.String getFilename()
          Getter for field FILENAME
 java.lang.String getFiltervalue()
          Getter for field FILTERVALUE
 java.lang.String getLocation()
          Getter for field LOCATION
 ICICSType<ICaptureSpecificationData> getObjectType()
           
 ICaptureSpecificationData.OperatorValue getOperator()
          Getter for field OPERATOR
 java.lang.Long getSeqnumber()
          Getter for field SEQNUMBER
 java.lang.String getStructname()
          Getter for field STRUCTNAME
 java.lang.String getVariablename()
          Getter for field VARIABLENAME
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

ICICSType<ICaptureSpecificationData> getObjectType()
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

getCapturespec

java.lang.String getCapturespec()
Getter for field CAPTURESPEC

Capture specification name

Specifies the name of the associated capture specification. The name can be up to 32 characters in length.


getEventbinding

java.lang.String getEventbinding()
Getter for field EVENTBINDING

Event binding name

Specifies the name of the associated event binding. The name can be up to 32 characters in length.


getContainer

java.lang.String getContainer()
Getter for field CONTAINER

Container name

Specifies a data area to receive the name of the container which contains the data if the LOCATION equals CHANNEL or FROMCHANNEL.


getFieldlength

java.lang.Long getFieldlength()
Getter for field FIELDLENGTH

Field length

Specifies the length of data to be tested for this predicate.


getFieldoffset

java.lang.Long getFieldoffset()
Getter for field FIELDOFFSET

The data offset within the data source

Specifies the data offset within the data source this predicate is found at.


getFilename

java.lang.String getFilename()
Getter for field FILENAME

Language structure file name

Specifies a data area to receive the first 32 characters of the name of the file which contains the imported language structure used to define this predicate.


getLocation

java.lang.String getLocation()
Getter for field LOCATION

Location of the data

Specifies a data area to receive the location of data to be tested.


getStructname

java.lang.String getStructname()
Getter for field STRUCTNAME

Language structure name

Specifies a data area to receive the first 32 characters of the name of the imported language structure used to define this predicate.


getVariablename

java.lang.String getVariablename()
Getter for field VARIABLENAME

Language structure variable name

Specifies a data area to receive the first 32 characters of the name of the variable in the imported language structure.


getOperator

ICaptureSpecificationData.OperatorValue getOperator()
Getter for field OPERATOR

Comparative operator for this predicate

Returns a CVDA that defines the operator that is used together with the value in the FILTERVALUE option when evaluating the predicate. The available CVDA values are as follows:

DOESNOTEQUAL
This predicate evaluates true if the value of the data item defined by LOCATION, FIELDOFFSET and FIELDLENGTH does not equal FILTERVALUE.
DOESNOTEXIST
This data predicate evaluates true if the data source identified by LOCATION does not exist.
DOESNOTSTART
The predicate evaluates true if the value of the data item defined by LOCATION, FIELDOFFSET and FIELDLENGTH does not start with FILTERVALUE.
EQUALS
The predicate evaluates true f the value of the data item defined by LOCATION, FIELDOFFSET and FIELDLENGTH equals FILTERVALUE.
EXISTS
This data predicate evaluates true if the data source identified by LOCATION exists.
GREATERTHAN
The predicate evaluates true if the value of the data item defined by LOCATION, FIELDOFFSET and FIELDLENGTH is greater than FILTERVALUE.
ISNOTGREATER
The predicate evaluates true if the value of the data item defined by LOCATION, FIELDOFFSET and FIELDLENGTH is equal to or less than FILTERVALUE.
ISNOTLESS
The predicate evaluates true if the value of the data item defined by LOCATION, FIELDOFFSET and FIELDLENGTH is equal to or greater than FILTERVALUE.
LESSTHAN
The predicate evaluates true if the value of the data item defined by LOCATION, FIELDOFFSET and FIELDLENGTH is less than FILTERVALUE.
STARTSWITH
The predicate evaluates true if the value of the data item defined by LOCATION, FIELDOFFSET and FIELDLENGTH starts with FILTERVALUE.


getSeqnumber

java.lang.Long getSeqnumber()
Getter for field SEQNUMBER

Browse sequence number

This number identifies the order in which the predicate resource was returned when using the EXEC CICS INQUIRE NEXT interface.


getFiltervalue

java.lang.String getFiltervalue()
Getter for field FILTERVALUE

Application data predicate value

Specifies a 255-character data area to receive the value of the Application Data predicate. Non-character predicates are converted to their character representation.


getCICSObjectReference

ICaptureSpecificationDataReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,ICaptureSpecificationData> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. The list factory can be activated by the caller when necessary. This method does not perform any I/O.



Copyright © 2008-2013 IBM Corp. All Rights Reserved.