Interface IXMLTransform
-
- All Superinterfaces:
ICICSObject,ICICSResource,com.ibm.cics.model.meta.ITypedObject
public interface IXMLTransform extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIXMLTransform.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classIXMLTransform.EnableStatusValueEnumeration type for field ENABLESTATUSstatic classIXMLTransform.InstallAgentValueEnumeration type for field INSTALLAGENTstatic classIXMLTransform.ValidationStatusValueEnumeration type for field VALIDATIONST
-
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 java.lang.LonggetBasdefinever()Getter for field BASDEFINEVERjava.lang.StringgetBundle()Getter for field BUNDLEjava.lang.LonggetCcsid()Getter for field CCSIDIXMLTransform.ChangeAgentValuegetChangeAgent()Getter for field CHANGEAGENTjava.lang.StringgetChangeAgentRelease()Getter for field CHANGEAGRELjava.util.DategetChangeTime()Getter for field CHANGETIMEjava.lang.StringgetChangeUserID()Getter for field CHANGEUSRIDIXMLTransformReferencegetCICSObjectReference()java.lang.StringgetDefineSource()Getter for field DEFINESOURCEjava.util.DategetDefineTime()Getter for field DEFINETIMEIXMLTransform.EnableStatusValuegetEnableStatus()Getter for field ENABLESTATUSIXMLTransform.InstallAgentValuegetInstallAgent()Getter for field INSTALLAGENTjava.util.DategetInstallTime()Getter for field INSTALLTIMEjava.lang.StringgetInstallUserID()Getter for field INSTALLUSRIDjava.lang.StringgetMappingLevel()Getter for field MAPPINGLEVELjava.lang.LonggetMappingReleaseNumber()Getter for field MAPPINGRNUMjava.lang.LonggetMappingVersionNumber()Getter for field MAPPINGVNUMjava.lang.StringgetMinimumRuntimeLevel()Getter for field MINRUNLEVELjava.lang.LonggetMinimumRuntimeReleaseNumber()Getter for field MINRUNRNUMjava.lang.LonggetMinimumRuntimeVersionNumber()Getter for field MINRUNVNUMjava.lang.StringgetName()Getter for field NAMEICICSType<IXMLTransform>getObjectType()java.lang.LonggetUseCount()Getter for field USECOUNTIXMLTransform.ValidationStatusValuegetValidationStatus()Getter for field VALIDATIONSTjava.lang.StringgetXmlSchema()Getter for field XMLSCHEMAjava.lang.StringgetXsdBind()Getter for field XSDBIND-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IXMLTransform> getObjectType()
- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field NAMEName
Specifies the name of this XML transform. The name can be up to 32 characters in length.
- Specified by:
getNamein interfaceICICSObject
-
getEnableStatus
IXMLTransform.EnableStatusValue getEnableStatus()
Getter for field ENABLESTATUSEnabled status
Returns a CVDA indicating the state of the XML transform. Values are:
- DISABLED
- The XML transform is not enabled.
- DISABLING
- The XML transform is in the process of being disabled. It is not available for further use, but inflight activity will be allowed to complete.
- ENABLED
- The XML transform is enabled.
- ENABLING
- The XML transform is in the process of being enabled.
-
getCcsid
java.lang.Long getCcsid()
Getter for field CCSIDCoded character set ID
The coded character set identifier (CCSID) that is used to encode the character data in the application data structure at runtime. This value is set using the optional CCSID parameter in the XML assistant when the XML binding file is generated. The CCSID is a value of up to 8 characters.
-
getBundle
java.lang.String getBundle()
Getter for field BUNDLEBundle name
Name of the bundle from which the XML transform is installed.
-
getChangeAgent
IXMLTransform.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CSDBATCH - The resource was last changed by a DFHCSDUP job.
- DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
- DYNAMIC - The resource was defined by an ATOMSERVICE resource.
- CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
- NOTAPPLIC - This is not applicable for this resource.
- OVERRIDE - Resource was last changed by resource overrides.
-
getChangeAgentRelease
java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGRELLast modification agent release
The CICS release level of the agent that made the last modification to the resource definition.
-
getChangeUserID
java.lang.String getChangeUserID()
Getter for field CHANGEUSRIDLast modification user ID
The user ID that made the last modification to the resource definition.
-
getDefineSource
java.lang.String getDefineSource()
Getter for field DEFINESOURCESource of the resource definition
The source of the definition, depending on which agent made the last change.
-
getInstallAgent
IXMLTransform.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENTInstallation agent
The install agent identifier that made the installation.
- BUNDLE - The resource was installed by a bundle deployment.
- DYNAMIC - The resource was installed by an ATOMSERVICE resource.
-
getInstallUserID
java.lang.String getInstallUserID()
Getter for field INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
getDefineTime
java.util.Date getDefineTime()
Getter for field DEFINETIMECreation time
The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
-
getChangeTime
java.util.Date getChangeTime()
Getter for field CHANGETIMELast modification time
The local date and time when the definition was last changed.
-
getInstallTime
java.util.Date getInstallTime()
Getter for field INSTALLTIMEInstallation time
The local date and time when the definition was installed
-
getBasdefinever
java.lang.Long getBasdefinever()
Getter for field BASDEFINEVERBAS resource definition version
The BAS version number of the bundle definition.
-
getValidationStatus
IXMLTransform.ValidationStatusValue getValidationStatus()
Getter for field VALIDATIONSTValidation status
Specifies whether full validation is enabled for the XML transform resource or not. CVDA values are:
- VALIDATION
- Full validation is enabled.
- NOVALIDATION
- Full validation is disabled.
-
getXsdBind
java.lang.String getXsdBind()
Getter for field XSDBINDXSD binding
The name of the XML binding file. The data area is 255 characters long. If the name is less than 255 characters, CICS pads the data area with trailing blanks.
-
getXmlSchema
java.lang.String getXmlSchema()
Getter for field XMLSCHEMAXML schema
The name of the associated XML schema file. The data area is 255 characters long. If the name is less than 255 characters, CICS pads the data area with trailing blanks.
-
getMappingVersionNumber
java.lang.Long getMappingVersionNumber()
Getter for field MAPPINGVNUMMapping version number
The version number for the mapping level that was used when the XML binding file was produced. The value of the version number is 1, 2, 3 or 4.
-
getMappingReleaseNumber
java.lang.Long getMappingReleaseNumber()
Getter for field MAPPINGRNUMMapping release number
The release number for the mapping level that was used when the XML binding file was produced. The value of the release number is 0, 1, or 2.
-
getMappingLevel
java.lang.String getMappingLevel()
Getter for field MAPPINGLEVELMapping level
The mapping level that was used when the XML binding file was produced.
-
getMinimumRuntimeLevel
java.lang.String getMinimumRuntimeLevel()
Getter for field MINRUNLEVELMinimum runtime level
The minimum runtime level that is required to install the XML transform in CICS.
-
getMinimumRuntimeVersionNumber
java.lang.Long getMinimumRuntimeVersionNumber()
Getter for field MINRUNVNUMMinimum runtime version number
The version number for the minimum runtime level that is required to install the XMLTRANSFORM in CICS.
-
getMinimumRuntimeReleaseNumber
java.lang.Long getMinimumRuntimeReleaseNumber()
Getter for field MINRUNRNUMMinimum runtime release number
The release number for the minimum runtime level that is required to install the XML transform in CICS.
-
getUseCount
java.lang.Long getUseCount()
Getter for field USECOUNTUse count
Number of times the XML transform has been used.
-
getCICSObjectReference
IXMLTransformReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICICSResource
-
-