Interface IAtomServiceDefinition
-
- All Superinterfaces:
ICICSDefinition,ICICSObject,IDefinition,com.ibm.cics.model.meta.ITypedObject
public interface IAtomServiceDefinition extends ICICSDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIAtomServiceDefinition.AtomTypeValueEnumeration type for field ATOMTYPEstatic classIAtomServiceDefinition.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classIAtomServiceDefinition.ResourcetypeValueEnumeration type for field RESOURCETYPEstatic classIAtomServiceDefinition.StatusValueEnumeration type for field STATUS
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IAtomServiceDefinition.AtomTypeValuegetAtomType()Getter for field ATOMTYPEjava.lang.StringgetBindfile()Getter for field BINDFILEIAtomServiceDefinition.ChangeAgentValuegetChangeAgent()Getter for field CHANGEAGENTICICSDefinitionReference<IAtomServiceDefinition>getCICSObjectReference()java.lang.StringgetConfigfile()Getter for field CONFIGFILEICICSType<IAtomServiceDefinition>getObjectType()java.lang.StringgetResourcename()Getter for field RESOURCENAMEIAtomServiceDefinition.ResourcetypeValuegetResourcetype()Getter for field RESOURCETYPEIAtomServiceDefinition.StatusValuegetStatus()Getter for field STATUSjava.lang.StringgetUserdata1()Getter for field USERDATA1java.lang.StringgetUserdata2()Getter for field USERDATA2java.lang.StringgetUserdata3()Getter for field USERDATA3-
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgentRelease, getChangeTime, getChangeUserID, getCICSContainer, getCreateTime, getCSDGroup, getDescription, getVersion
-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IAtomServiceDefinition> getObjectType()
- Specified by:
getObjectTypein interfaceICICSDefinition- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfaceIDefinition- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
IAtomServiceDefinition.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 - Resource was last changed by a SM API command.
-
getStatus
IAtomServiceDefinition.StatusValue getStatus()
Getter for field STATUSEnabled 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 ATOMTYPEAtomtype
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 RESOURCETYPEResource 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 RESOURCENAMEResource 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 BINDFILEBind 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 CONFIGFILEConfiguration 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 USERDATA1User 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 USERDATA2User 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 USERDATA3User 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:
getCICSObjectReferencein interfaceICICSDefinition- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceIDefinition
-
-