com.ibm.cics.model
Interface IPipelineDefinition

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

public interface IPipelineDefinition
extends ICICSDefinition

generated from CICS resourcetable PIPEDEF


Nested Class Summary
static interface IPipelineDefinition.ResponseWaitSecondsValue
          Long constants interface for field RESPWAIT
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IPipelineDefinition> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 ICICSDefinitionReference<IPipelineDefinition> getCICSObjectReference()
           
 java.lang.String getConfigurationFile()
          Getter for field CONFIGFILE
 ICICSType<IPipelineDefinition> getObjectType()
           
 java.lang.Long getResponseWaitSeconds()
          Getter for field RESPWAIT
 java.lang.String getShelf()
          Getter for field SHELF
 ICICSEnums.EnablementValue getStatus()
          Getter for field STATUS
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 java.lang.String getWSDirectory()
          Getter for field WSDIR
 
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime, getCSDGroup, getDescription, getVersion
 
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<IPipelineDefinition> getObjectType()
Specified by:
getObjectType in interface ICICSDefinition
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface IDefinition
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

getUserdata1

java.lang.String getUserdata1()
Getter for field USERDATA1

User data area 1

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata2

java.lang.String getUserdata2()
Getter for field USERDATA2

User data area 2

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getUserdata3

java.lang.String getUserdata3()
Getter for field USERDATA3

User data area 3

Optional string of up to 8 characters that allows you to provide additional site-specific data related to the BAS resource definition. This field is ignored for CICS CSD resource definitions.


getConfigurationFile

java.lang.String getConfigurationFile()
Getter for field CONFIGFILE

Configuration file name on HFS for this pipeline

The name of the pipeline configuration file associated with the PIPELINE resource. The name can be up to 255 characters long.


getShelf

java.lang.String getShelf()
Getter for field SHELF

Name of a directory (shelf) for WSBind files

The name of the shelf directory. The name can be up to 255 characters long.


getStatus

ICICSEnums.EnablementValue getStatus()
Getter for field STATUS

ENABLED status

The status of the PIPELINE:


getWSDirectory

java.lang.String getWSDirectory()
Getter for field WSDIR

Name of the WSBind (pickup) directory on HFS

The name of the Web service binding directory (also known as the pickup directory). The name can be up to 255 characters long.


getResponseWaitSeconds

java.lang.Long getResponseWaitSeconds()
Getter for field RESPWAIT

Response wait time for Requester Pipeline (SSSS)

Specifies the number of seconds that an application program should wait for a response message from a remote Web service. The value can range from 0 to 9999 seconds, or may specify the keyword value of DEFT. If you specify RESPWAIT(DEFT) for this attribute, the default timeout value of the transport protocol is used:


getCICSObjectReference

ICICSDefinitionReference<IPipelineDefinition> getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSDefinition
Specified by:
getCICSObjectReference in interface ICICSObject
Specified by:
getCICSObjectReference in interface IDefinition

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,IPipelineDefinition> 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.