com.ibm.cics.model
Interface IRequestModelDefinition

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

public interface IRequestModelDefinition
extends ICICSDefinition

generated from CICS resourcetable RQMDEF


Nested Class Summary
static class IRequestModelDefinition.IntfacetypeValue
          Enumeration type for field INTFACETYPE
static class IRequestModelDefinition.RtypeValue
          Enumeration type for field RTYPE
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IRequestModelDefinition> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 java.lang.String getBeanname()
          Getter for field BEANNAME
 ICICSDefinitionReference<IRequestModelDefinition> getCICSObjectReference()
           
 java.lang.String getCorbaserver()
          Getter for field CORBASERVER
 java.lang.String getInterface()
          Getter for field INTERFACE
 IRequestModelDefinition.IntfacetypeValue getIntfacetype()
          Getter for field INTFACETYPE
 java.lang.String getModule()
          Getter for field MODULE
 ICICSType<IRequestModelDefinition> getObjectType()
           
 java.lang.String getOmginterface()
          Getter for field OMGINTERFACE
 java.lang.String getOmgmodule()
          Getter for field OMGMODULE
 java.lang.String getOmgoperation()
          Getter for field OMGOPERATION
 java.lang.String getOperation()
          Getter for field OPERATION
 IRequestModelDefinition.RtypeValue getRtype()
          Getter for field RTYPE
 java.lang.String getTransid()
          Getter for field TRANSID
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 
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<IRequestModelDefinition> 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

getOmgmodule

java.lang.String getOmgmodule()
Getter for field OMGMODULE

Object management group (OMG) module name

This attribute is obsolete, but is supported to provide BAS definition support for earlier releases of CICS. If this attribute is present in the request model definition, the following attributes must be blank: BEANNAME, CORBASERVER, INTFACETYPE, INTERFACE, OPERATION and RTYPE.


getOmginterface

java.lang.String getOmginterface()
Getter for field OMGINTERFACE

Object management group (OMG) interface name

This attribute is obsolete, but is supported to provide BAS definition support for earlier releases of CICS. If this attribute is present in the request model definition, the following attributes must be blank: BEANNAME, CORBASERVER, INTFACETYPE, INTERFACE, OPERATION and RTYPE.


getOmgoperation

java.lang.String getOmgoperation()
Getter for field OMGOPERATION

Object management group (OMG) operation name

This attribute is obsolete, but is supported to provide BAS definition support for earlier releases of CICS. If this attribute is present in the request model definition, the following attributes must be blank: BEANNAME, CORBASERVER, INTFACETYPE, INTERFACE, OPERATION and RTYPE.


getTransid

java.lang.String getTransid()
Getter for field TRANSID

CICS transaction ID

The 4-character name of the CICS transaction to be used when a new request processor transaction instance is required to process a method request matching the specification of the REQUESTMODEL. The transaction definition must have as its initial program a JVM program whose JVMClass is com.ibm.cics.iiop.RequestProcessor. It must be installed in all the AORs of the logical EJB server; it need not be installed in listener regions that are not also AORs.


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.


getCorbaserver

java.lang.String getCorbaserver()
Getter for field CORBASERVER

CorbaServer

The name of the destination CORBASERVER for this REQUESTMODEL. The name can be up to 4 characters in length. The acceptable characters are A-Z a-z 0-9. You can also use an asterisk as the last (or only) character to specify a generic name. If a generic CORBASERVER is specified, BEANNAME, the CORBA attributes (MODULE and INTERFACE), and the COMMON attributes (OPERATION) must all be an asterisk (*); INTFACETYPE must be BOTH. For any release prior to CICS TS Version 6 Release 2, if any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) are present in the request model definition, CORBASERVER must be blank, otherwise CORBASERVER is a required attribute.


getRtype

IRequestModelDefinition.RtypeValue getRtype()
Getter for field RTYPE

Request model type

The type of REQUESTMODEL:


getIntfacetype

IRequestModelDefinition.IntfacetypeValue getIntfacetype()
Getter for field INTFACETYPE

Java interface type

The Java interface type for this REQUESTMODEL:


getBeanname

java.lang.String getBeanname()
Getter for field BEANNAME

Enterprise bean

A bean name, of up to 240 characters, matching the name of the enterprise bean in the XML deployment descriptor. The acceptable characters are A-Z a-z 0-9 . - _ and accented alphabetic characters.

If you specify a generic value for BEANNAME, then you must specify INTFACETYPE as BOTH and OPERATION as *. If you specify RTYPE as generic, you must specify BEANNAME as *. For CORBA REQUESTMODELs - that is, if RTYPE is CORBA, this field should be blank.


getModule

java.lang.String getModule()
Getter for field MODULE

Module name

A name, of up to 255 characters, matching the IDL module name (which defines the name scope of the interface and operation). The acceptable characters are A-Z a-z 0-9 _. Characters outside this range may give unpredictable results. You can, however, use an asterisk as the last (or only) character to specify a generic name.

Case is significant and should match the original Java or IDL source. To comply with CORBA, however, installation of REQUESTMODELs that specify MODULE with values differing only in case from previously installed definitions will be rejected. If you specify a generic value for MODULE, then you must specify INTERFACE as * and OPERATION as *. If you specify RTYPE as GENERIC, you must specify MODULE as *. To indicate the default package, leave this field blank and specify a non-blank (but possibly generic) INTERFACE. For EJB REQUESTMODELs - that is, if RTYPE is EJB - this field should be blank. If any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) are present in the request model definition, MODULE must be blank.


getInterface

java.lang.String getInterface()
Getter for field INTERFACE

Interface name

A name, of up to 255 characters, matching the IDL interface name. The acceptable characters are A-Z a-z 0-9 _ : and accented alphabetic characters.

Case is significant and should match the original Java or IDL source. To comply, however, with CORBA, installation of REQUESTMODELS that specify INTERFACE with values differing only in case from previously installed definitions, will be rejected. If a generic INTERFACE is specified, the common attributes (OPERATION) must be an asterisk (*). For EJB REQUESTMODELs - that is, if RTYPE is EJB - this field should be blank. If you specify RTYPE as GENERIC, you must specify INTERFACE(*). If any of the obsolete attribute values (OMGINTERFACE, OMGMODULE and OMGOPERATION) are present in the request model definition, INTERFACE must be blank.


getOperation

java.lang.String getOperation()
Getter for field OPERATION

Operation name

A name, of up to 255 characters, matching the IDL operation or an IDL representation of the bean method signature. The acceptable characters are A-Z a-z 0-9 _ and accented alphabetic characters.


getCICSObjectReference

ICICSDefinitionReference<IRequestModelDefinition> 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,IRequestModelDefinition> 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.