Interface IAtomService
-
- All Superinterfaces:
ICICSObject,ICICSResource,IInstalledCICSResource,com.ibm.cics.model.meta.ITypedObject
public interface IAtomService extends ICICSResource, IInstalledCICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIAtomService.AtomTypeValueEnumeration type for field ATOMTYPEstatic classIAtomService.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classIAtomService.EnablestatusValueEnumeration type for field ENABLESTATUSstatic classIAtomService.InstallAgentValueEnumeration type for field INSTALLAGENTstatic classIAtomService.ResourcetypeValueEnumeration type for field RESOURCETYPE
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
Fields inherited from interface com.ibm.cics.model.IInstalledCICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.LonggetAtmsrvdelent()Getter for field ATMSRVDELENTjava.lang.LonggetAtmsrvgetent()Getter for field ATMSRVGETENTjava.lang.LonggetAtmsrvgetfed()Getter for field ATMSRVGETFEDjava.lang.LonggetAtmsrvpstfed()Getter for field ATMSRVPSTFEDjava.lang.LonggetAtmsrvputent()Getter for field ATMSRVPUTENTjava.lang.LonggetAtmsrvrefct()Getter for field ATMSRVREFCTjava.lang.LonggetAtmsrvrefdis()Getter for field ATMSRVREFDISIAtomService.AtomTypeValuegetAtomType()Getter for field ATOMTYPEjava.lang.LonggetBasdefinever()Getter for field BASDEFINEVERjava.lang.StringgetBindfile()Getter for field BINDFILEIAtomService.ChangeAgentValuegetChangeAgent()Getter for field CHANGEAGENTjava.lang.StringgetChangeAgentRelease()Getter for field CHANGEAGRELjava.util.DategetChangeTime()Getter for field CHANGETIMEjava.lang.StringgetChangeUserID()Getter for field CHANGEUSRIDIAtomServiceReferencegetCICSObjectReference()java.lang.StringgetConfigfile()Getter for field CONFIGFILEjava.lang.StringgetDefineSource()Getter for field DEFINESOURCEjava.util.DategetDefineTime()Getter for field DEFINETIMEIAtomService.EnablestatusValuegetEnablestatus()Getter for field ENABLESTATUSIAtomService.InstallAgentValuegetInstallAgent()Getter for field INSTALLAGENTjava.util.DategetInstallTime()Getter for field INSTALLTIMEjava.lang.StringgetInstallUserID()Getter for field INSTALLUSRIDjava.lang.StringgetName()Getter for field NAMEICICSType<IAtomService>getObjectType()java.lang.StringgetResourcename()Getter for field RESOURCENAMEIAtomService.ResourcetypeValuegetResourcetype()Getter for field RESOURCETYPEjava.lang.StringgetUrimapname()Getter for field URIMAPNAMEjava.lang.StringgetXmltransname()Getter for field XMLTRANSNAME-
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<IAtomService> 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 ATOMSERV. The name can be up to eight characters in length.
- Specified by:
getNamein interfaceICICSObject
-
getEnablestatus
IAtomService.EnablestatusValue getEnablestatus()
Getter for field ENABLESTATUSEnabled status
Indicates whether the ATOMSERV is enabled or not. Values are:
- DISABLED
- The ATOMSERV is not enabled.
- ENABLED
- The ATOMSERV is enabled.
-
getAtomType
IAtomService.AtomTypeValue getAtomType()
Getter for field ATOMTYPEAtomtype
Displays the type of Atom document that is produced by this ATOMSERVICE definition. The possible values are as follows:
- Category
- An Atom category document, which lists the categories of documents in a collection.
- Collection
- An Atom collection document, which contains a group of entry documents that can be edited.
- Feed
- An Atom feed document, which describes the metadata for a feed, and contains entry documents that provide data for the feed.
- Service
- An Atom service document, which provides information about the collections of entry documents that are available on the server and can be added to or edited.
-
getResourcetype
IAtomService.ResourcetypeValue getResourcetype()
Getter for field RESOURCETYPEResource type
Displays the type of CICS resource that provides the data for this Atom feed or collection. This field does not apply to an Atom service or category document. The possible values are as follows:
- File
- A CICS file.
- Program
- A service routine, which is a CICS application program written to supply content for Atom entries.
- Tsqueue
- A temporary storage queue.
- NOTAPPLIC
- This is not applicable for this resource.
-
getInstallAgent
IAtomService.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENTInstallation agent
The install agent identifier that made the installation.
- CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CREATESPI - The resource was installed by an EXEC CICS CREATE command.
- GRPLIST - The resource was installed by GRPLIST INSTALL.
- BUNDLE - The resource was installed by a bundle deployment.
-
getResourcename
java.lang.String getResourcename()
Getter for field RESOURCENAMEResource name
Displays the name of the CICS resource that provides the data for this Atom feed or collection. This field does not apply to an Atom service or category document.
-
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.
-
getChangeUserID
java.lang.String getChangeUserID()
Getter for field CHANGEUSRIDLast modification user ID
The user ID that made the last modification to the resource definition.
-
getChangeAgent
IAtomService.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.
- DREPBATCH - The resource was last changed by a CICSPlex SM utility.
- 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.
-
getChangeTime
java.util.Date getChangeTime()
Getter for field CHANGETIMELast modification time
The local date and time when the definition was last changed.
-
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.
-
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.
-
getInstallUserID
java.lang.String getInstallUserID()
Getter for field INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
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 this definition.
-
getAtmsrvrefct
java.lang.Long getAtmsrvrefct()
Getter for field ATMSRVREFCTAtom Service reference count
Atom Service reference count
-
getAtmsrvrefdis
java.lang.Long getAtmsrvrefdis()
Getter for field ATMSRVREFDISAtom Service reference disabled count
Atom Service reference disabled count
-
getAtmsrvpstfed
java.lang.Long getAtmsrvpstfed()
Getter for field ATMSRVPSTFEDNumber of POST requests to the feed URL
The number of HTTP POST requests sent to the feed URL.
-
getAtmsrvgetfed
java.lang.Long getAtmsrvgetfed()
Getter for field ATMSRVGETFEDNumber of GET requests to the feed URL
The number of HTTP GET requests sent to the feed URL.
-
getAtmsrvgetent
java.lang.Long getAtmsrvgetent()
Getter for field ATMSRVGETENTNumber of GET requests to the entry URL
The number of HTTP GET requests sent to the entry URL.
-
getAtmsrvputent
java.lang.Long getAtmsrvputent()
Getter for field ATMSRVPUTENTNumber of PUT requests to the entry URL
The number of HTTP PUT requests sent to the entry URL.
-
getAtmsrvdelent
java.lang.Long getAtmsrvdelent()
Getter for field ATMSRVDELENTNumber of DELETE requests to the entry URL
The number of HTTP DELETE requests sent to the entry URL.
-
getUrimapname
java.lang.String getUrimapname()
Getter for field URIMAPNAMEURIMAP name
Displays the 8-character URIMAP name that indicates the URI associated with this ATOMSERVICE definition.
-
getXmltransname
java.lang.String getXmltransname()
Getter for field XMLTRANSNAMEXMLTRANSFORM name
Displays the 32-character name of the XMLTRANSFORM resource associated with the ATOMSERVICE definition.
-
getCICSObjectReference
IAtomServiceReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICICSResource
-
-