com.ibm.cics.model
Interface IAtomServiceDefinition

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

public interface IAtomServiceDefinition
extends ICICSDefinition

generated from CICS resourcetable ATOMDEF


Nested Class Summary
static class IAtomServiceDefinition.AtomTypeValue
          Enumeration type for field ATOMTYPE
static class IAtomServiceDefinition.ResourcetypeValue
          Enumeration type for field RESOURCETYPE
static class IAtomServiceDefinition.StatusValue
          Enumeration type for field STATUS
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IAtomServiceDefinition> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 IAtomServiceDefinition.AtomTypeValue getAtomType()
          Getter for field ATOMTYPE
 java.lang.String getBindfile()
          Getter for field BINDFILE
 ICICSDefinitionReference<IAtomServiceDefinition> getCICSObjectReference()
           
 java.lang.String getConfigfile()
          Getter for field CONFIGFILE
 ICICSType<IAtomServiceDefinition> getObjectType()
           
 java.lang.String getResourcename()
          Getter for field RESOURCENAME
 IAtomServiceDefinition.ResourcetypeValue getResourcetype()
          Getter for field RESOURCETYPE
 IAtomServiceDefinition.StatusValue 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
 
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<IAtomServiceDefinition> 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

getStatus

IAtomServiceDefinition.StatusValue getStatus()
Getter for field STATUS

Enabled status

Indicates whether the ATOMSERV is enabled or not. Values are:

DISABLED
The ATOMSERV is not enabled.
ENABLED
The ATOMSERV is enabled.


getAtomType

IAtomServiceDefinition.AtomTypeValue getAtomType()
Getter for field ATOMTYPE

Atomtype

The type of Atom document to be returned. It can be Feed, Service, Collection or Category. Entry documents are always specified within Feed or Collection documents. Values are:

FEED
The ATOMSERV inquire request will return feed data.
SERVICE
The ATOMSERV inquire request will return service data.
COLLECTION
The ATOMSERV inquire request will return collection data.
CATEGORY
The ATOMSERV inquire request will return category data.


getResourcetype

IAtomServiceDefinition.ResourcetypeValue getResourcetype()
Getter for field RESOURCETYPE

Resource type

Indicates the type of CICS resource that holds the data for an Atom feed or collection. Values are:

FILE
The named resource is a file.
PROGRAM
The named resource is a program.
TSQUEUE
The named resource is a TSQ.
NOTAPPLIC
This is not applicable for this resource.


getResourcename

java.lang.String getResourcename()
Getter for field RESOURCENAME

Resource name

The name of the CICS resource that provides the data for an Atom feed or collection. A mixed case name is acceptable if the RESOURCETYPE is TSQUEUE. If the RESOURCETYPE is FILE or PROGRAM then CICSPlex SM changes any lowercase characters to uppercase.


getBindfile

java.lang.String getBindfile()
Getter for field BINDFILE

Bind file name

The name of a UNIX file that contains WSBIND data describing the record layouts within the CICS resource.


getConfigfile

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

Configuration file name

The name of a UNIX file that contains XML configuration data specifying the type of Atom document being returned.


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.


getCICSObjectReference

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