com.ibm.cics.model
Interface IXMLTransform

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

public interface IXMLTransform
extends ICICSResource

generated from CICS resourcetable XMLTRANS


Nested Class Summary
static class IXMLTransform.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class IXMLTransform.EnableStatusValue
          Enumeration type for field ENABLESTATUS
static class IXMLTransform.InstallAgentValue
          Enumeration type for field INSTALLAGENT
static class IXMLTransform.ValidationStatusValue
          Enumeration type for field VALIDATIONST
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IXMLTransform> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 java.lang.String getBundle()
          Getter for field BUNDLE
 java.lang.Long getCcsid()
          Getter for field CCSID
 IXMLTransform.ChangeAgentValue getChangeAgent()
          Getter for field CHANGEAGENT
 java.lang.String getChangeAgentRelease()
          Getter for field CHANGEAGREL
 java.util.Date getChangeTime()
          Getter for field CHANGETIME
 java.lang.String getChangeUserID()
          Getter for field CHANGEUSRID
 IXMLTransformReference getCICSObjectReference()
           
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 IXMLTransform.EnableStatusValue getEnableStatus()
          Getter for field ENABLESTATUS
 IXMLTransform.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 java.lang.String getMappingLevel()
          Getter for field MAPPINGLEVEL
 java.lang.Long getMappingReleaseNumber()
          Getter for field MAPPINGRNUM
 java.lang.Long getMappingVersionNumber()
          Getter for field MAPPINGVNUM
 java.lang.String getMinimumRuntimeLevel()
          Getter for field MINRUNLEVEL
 java.lang.Long getMinimumRuntimeReleaseNumber()
          Getter for field MINRUNRNUM
 java.lang.Long getMinimumRuntimeVersionNumber()
          Getter for field MINRUNVNUM
 java.lang.String getName()
          Getter for field NAME
 ICICSType<IXMLTransform> getObjectType()
           
 java.lang.Long getUseCount()
          Getter for field USECOUNT
 IXMLTransform.ValidationStatusValue getValidationStatus()
          Getter for field VALIDATIONST
 java.lang.String getXmlSchema()
          Getter for field XMLSCHEMA
 java.lang.String getXsdBind()
          Getter for field XSDBIND
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

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

getName

java.lang.String getName()
Getter for field NAME

Name

Specifies the name of this XML transform. The name can be up to 32 characters in length.

Specified by:
getName in interface ICICSObject

getEnableStatus

IXMLTransform.EnableStatusValue getEnableStatus()
Getter for field ENABLESTATUS

Enabled 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 CCSID

Coded 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 BUNDLE

Bundle name

Name of the bundle from which the XML transform is installed.


getChangeAgent

IXMLTransform.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENT

Last modification agent

The change agent identifier that made the last modification.


getChangeAgentRelease

java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGREL

Last 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 CHANGEUSRID

Last modification user ID

The user ID that made the last modification to the resource definition.


getDefineSource

java.lang.String getDefineSource()
Getter for field DEFINESOURCE

Source of the resource definition

The source of the definition, depending on which agent made the last change.


getInstallAgent

IXMLTransform.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENT

Installation agent

The install agent identifier that made the installation.


getInstallUserID

java.lang.String getInstallUserID()
Getter for field INSTALLUSRID

Installation user ID

The user ID that installed the resource definition.


getDefineTime

java.util.Date getDefineTime()
Getter for field DEFINETIME

Creation 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 CHANGETIME

Last modification time

The local date and time when the definition was last changed.


getInstallTime

java.util.Date getInstallTime()
Getter for field INSTALLTIME

Installation time

The local date and time when the definition was installed


getBasdefinever

java.lang.Long getBasdefinever()
Getter for field BASDEFINEVER

BAS resource definition version

The BAS version number of the bundle definition.


getValidationStatus

IXMLTransform.ValidationStatusValue getValidationStatus()
Getter for field VALIDATIONST

Validation 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 XSDBIND

XSD 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 XMLSCHEMA

XML 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 MAPPINGVNUM

Mapping 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, or 3.


getMappingReleaseNumber

java.lang.Long getMappingReleaseNumber()
Getter for field MAPPINGRNUM

Mapping 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 MAPPINGLEVEL

Mapping level

The mapping level that was used when the XML binding file was produced.


getMinimumRuntimeLevel

java.lang.String getMinimumRuntimeLevel()
Getter for field MINRUNLEVEL

Minimum runtime level

The minimum runtime level that is required to install the XML transform in CICS.


getMinimumRuntimeVersionNumber

java.lang.Long getMinimumRuntimeVersionNumber()
Getter for field MINRUNVNUM

Minimum 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 MINRUNRNUM

Minimum 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 USECOUNT

Use count

Number of times the XML transform has been used.


getCICSObjectReference

IXMLTransformReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

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