Interface IBundle
-
- All Superinterfaces:
ICICSObject,ICICSResource,IInstalledCICSResource,com.ibm.cics.model.meta.ITypedObject
public interface IBundle extends ICICSResource, IInstalledCICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classIBundle.AvailabilityValueEnumeration type for field AVAILSTATUSstatic classIBundle.ChangeAgentValueEnumeration type for field CHANGEAGENTstatic classIBundle.InstallAgentValueEnumeration type for field INSTALLAGENTstatic classIBundle.StatusValueEnumeration type for field ENABLESTATUS
-
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 IBundle.AvailabilityValuegetAvailability()Getter for field AVAILSTATUSjava.lang.LonggetBasdefinever()Getter for field BASDEFINEVERjava.lang.StringgetBasescope()Getter for field BASESCOPEjava.lang.StringgetBundledir()Getter for field BUNDLEDIRjava.lang.StringgetBundleID()Getter for field BUNDLEIDIBundle.ChangeAgentValuegetChangeAgent()Getter for field CHANGEAGENTjava.lang.StringgetChangeAgentRelease()Getter for field CHANGEAGRELjava.util.DategetChangeTime()Getter for field CHANGETIMEjava.lang.StringgetChangeUserID()Getter for field CHANGEUSRIDIBundleReferencegetCICSObjectReference()java.lang.StringgetDefineSource()Getter for field DEFINESOURCEjava.util.DategetDefineTime()Getter for field DEFINETIMEjava.lang.LonggetEnabledcount()Getter for field ENABLEDCOUNTIBundle.InstallAgentValuegetInstallAgent()Getter for field INSTALLAGENTjava.util.DategetInstallTime()Getter for field INSTALLTIMEjava.lang.StringgetInstallUserID()Getter for field INSTALLUSRIDjava.lang.LonggetMajorVersion()Getter for field MAJORVERSIONjava.lang.StringgetMgmtpart()Getter for field MGMTPARTjava.lang.LonggetMicroVersion()Getter for field MICROVERSIONjava.lang.LonggetMinorVersion()Getter for field MINORVERSIONjava.lang.StringgetName()Getter for field NAMEICICSType<IBundle>getObjectType()java.lang.LonggetPartcount()Getter for field PARTCOUNTIBundle.StatusValuegetStatus()Getter for field ENABLESTATUSjava.lang.LonggetTargetcount()Getter for field TARGETCOUNT-
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<IBundle> getObjectType()
- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field NAMECICS bundle name
Specifies the name of this BUNDLE. The name can be up to eight characters in length.
- Specified by:
getNamein interfaceICICSObject
-
getChangeAgent
IBundle.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.
-
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
IBundle.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.
- CLOUD - The resource was installed by a Management Part.
-
getInstallUserID
java.lang.String getInstallUserID()
Getter for field INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
getStatus
IBundle.StatusValue getStatus()
Getter for field ENABLESTATUSEnable status
Returns the status of BUNDLE.
- ENABLED - The BUNDLE is ready for use.
- DISABLED - The BUNDLE is not available.
- ENABLING - The BUNDLE is being initialized. It is creating and enabling the resources that are defined in the bundle's manifest file.
- DISABLING - The BUNDLE is quiescing before entering DISABLED state. It disables any resources it enabled.
- DISCARDING - A DISCARD command has been issued for the BUNDLE. The BUNDLE is quiescing before being discarded. The Bundle discards any resources that it disabled.
-
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
-
getBundledir
java.lang.String getBundledir()
Getter for field BUNDLEDIRName of the Bundle directory on zFS
Specifies the 1 to 255 character fully-qualified name of the Bundle directory on zFS
-
getBasdefinever
java.lang.Long getBasdefinever()
Getter for field BASDEFINEVERBAS definition version
The BAS version number of this definition.
-
getBasescope
java.lang.String getBasescope()
Getter for field BASESCOPEBase scope
Specifies the 1 - 255 character universal resource identifier (URI) that defines the root namespace where the contents of the bundle are created. Use a scope value when you want to logically group different bundles together.
-
getPartcount
java.lang.Long getPartcount()
Getter for field PARTCOUNTPart count
The total number of imports, exports, definitions, entry points and policy scope statements that are defined in the bundle manifest.
-
getTargetcount
java.lang.Long getTargetcount()
Getter for field TARGETCOUNTTarget count
The target number of dynamically created resources and resource modifiers in the bundle. CICS automatically enables the BUNDLE resource when all of the dynamically created resources and modifiers are in an enabled state.
-
getEnabledcount
java.lang.Long getEnabledcount()
Getter for field ENABLEDCOUNTEnabled count
The current number of dynamically created resources and resource modifiers in the bundle that are enabled in the CICS region.
-
getBundleID
java.lang.String getBundleID()
Getter for field BUNDLEIDBundle ID
The ID of the bundle.
-
getMajorVersion
java.lang.Long getMajorVersion()
Getter for field MAJORVERSIONMajor version
The major version of the bundle.
-
getMinorVersion
java.lang.Long getMinorVersion()
Getter for field MINORVERSIONMinor version
The minor version of the bundle.
-
getMicroVersion
java.lang.Long getMicroVersion()
Getter for field MICROVERSIONMicro version
The micro version of the bundle.
-
getMgmtpart
java.lang.String getMgmtpart()
Getter for field MGMTPARTManagement part ID
The Id of the management part that created this bundle, if applicable.
-
getAvailability
IBundle.AvailabilityValue getAvailability()
Getter for field AVAILSTATUSAvailability status
Returns the availability status of the BUNDLE.
- AVAILABLE - All entry points in the BUNDLE resource are available.
- UNAVAILABLE - No entry points in the BUNDLE resource are available.
- SOMEAVAIL - Some entry points in the BUNDLE resource are available.
- NONE - The BUNDLE does not contain any entry points.
-
getCICSObjectReference
IBundleReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICICSResource
-
-