Interface ILibrary
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,IInstalledCICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface ILibrary extends ICICSResource, IInstalledCICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ILibrary.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
ILibrary.CriticalStatusValue
Enumeration type for field CRITSTATUSstatic class
ILibrary.EnableStatusValue
Enumeration type for field ENABLESTATUSstatic class
ILibrary.InstallAgentValue
Enumeration type for field INSTALLAGENT
-
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.Long
getBasdefinever()
Getter for field BASDEFINEVERILibrary.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTjava.lang.String
getChangeAgentRelease()
Getter for field CHANGEAGRELjava.util.Date
getChangeTime()
Getter for field CHANGETIMEjava.lang.String
getChangeUserID()
Getter for field CHANGEUSRIDILibraryReference
getCICSObjectReference()
ILibrary.CriticalStatusValue
getCriticalStatus()
Getter for field CRITSTATUSjava.lang.String
getDefineSource()
Getter for field DEFINESOURCEjava.util.Date
getDefineTime()
Getter for field DEFINETIMEILibrary.EnableStatusValue
getEnableStatus()
Getter for field ENABLESTATUSILibrary.InstallAgentValue
getInstallAgent()
Getter for field INSTALLAGENTjava.util.Date
getInstallTime()
Getter for field INSTALLTIMEjava.lang.String
getInstallUserID()
Getter for field INSTALLUSRIDjava.lang.String
getName()
Getter for field NAMEjava.lang.Long
getNumdsnames()
Getter for field NUMDSNAMESICICSType<ILibrary>
getObjectType()
java.lang.Long
getPgmloadcnt()
Getter for field PGMLOADCNTjava.lang.Long
getRanking()
Getter for field RANKINGjava.lang.Long
getSearchPosition()
Getter for field SEARCHPOS-
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<ILibrary> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field NAMELIBRARY name
The name of the LIBRARY.
- Specified by:
getName
in interfaceICICSObject
-
getRanking
java.lang.Long getRanking()
Getter for field RANKINGRanking
The number which determines where this LIBRARY will appear in the overall search order, when enabled. A lower number indicates that this LIBRARY will be searched for programs to load before other LIBRARY resources with higher ranking numbers. The ranking can be thought of as being somewhat analogous to the concatenation number of a data set within a LIBRARY concatenation, although it differs in allowing duplicate values. RANKING can take values between 1 and 99, with a default of 50. A value of 10 is reserved for DFHRPL, the static LIBRARY, and cannot be specified.
If this LIBRARY contains a discrete application in one or more data sets, then its ranking relative to other LIBRARY resources is not usually significant, and the default ranking value can be accepted. Exceptions to this are where this LIBRARY contains a program artifact which is required to replace one that also appears in another LIBRARY, in which case the ranking of this LIBRARY needs to be a smaller value than that of the other LIBRARY to ensure that the program artifact is loaded from this LIBRARY.
The DFHRPL concatenation is assigned a predefined ranking of 10. This value cannot be changed. It allows dynamically defined LIBRARY resources to be placed before the DFHRPL concatenation in the overall search order by giving them a ranking value smaller than 10.
Note:
- It should be regarded as a temporary situation to have LIBRARY resources with a ranking that places them before DFHRPL in the search order.
- Although the predefined DFHRPL ranking of 10 is intended to discourage the placing of LIBRARY resources before DFHRPL in the search order, it does not limit the total number of LIBRARY resources that can be placed before DFHRPL providing the ranking between the LIBRARY resources themselves is not significant. A ranking of less than 10 will trigger a message, where possible, to inform the user that this LIBRARY will appear ahead of DFHRPL in the search order.
- A ranking of less than 10 will not take effect until the program is first loaded, or a NEWCOPY or PHASEIN request is issued, to cause the program to be loaded from the dynamic LIBRARY in preference to DFHRPL, unless the program is not in the DFHRPL concatenation, in which case there would be no reason to use a ranking of less than 10.
-
getCriticalStatus
ILibrary.CriticalStatusValue getCriticalStatus()
Getter for field CRITSTATUSCritical status
Specifies whether the LIBRARY is critical to the start up of CICS. Values are:
- CRITICAL
- The LIBRARY is critical to CICS startup. If the LIBRARY cannot be successfully installed during CICS startup for any reason, then a GO or CANCEL message will be issued. This will allow the operator to decide whether to override the criticality and allow CICS to start or not. If CICS is allowed to continue, the LIBRARY will be installed in a 'disabled' status, unless install was not possible at all; for example, due to a short-on-storage condition. If the reply is to continue with the startup, the LIBRARY will not be recatalogued as NONCRITICAL, so the critical status should be explicitly set to NONCRITICAL if it is decided that the LIBRARY should not be regarded as CRITICAL in future.
- NONCRITICAL
- The LIBRARY is not critical to CICS startup. If the LIBRARY cannot be successfully installed during CICS startup, then the LIBRARY will be left in an installed but disabled state and a warning message will be issued, but CICS startup will continue.
-
getEnableStatus
ILibrary.EnableStatusValue getEnableStatus()
Getter for field ENABLESTATUSEnable status
Indicates whether the LIBRARY is included in the overall LIBRARY search order. Values are:
- DISABLED
- The LIBRARY is not included in the LIBRARY search order. The data sets in this LIBRARY concatenation will not be searched for program artifacts to load.
- DISABLING
- A request to disable the LIBRARY has been received, but is still being processed.
- ENABLED
- The LIBRARY is included in the LIBRARY search order. The data sets in this LIBRARY concatenation will be searched for program artifacts to load.
- ENABLING
- A request to enable the LIBRARY has been received, but is still being processed.
- DISCARDING
- A request to discard the LIBRARY from the CICS system has been received, but is still being processed.
-
getNumdsnames
java.lang.Long getNumdsnames()
Getter for field NUMDSNAMESNumber of DSNAMEs
The number of data sets in the LIBRARY concatenation. For a dynamically defined LIBRARY, this will be the number of non-blank DSNAMExx values, and cannot be a value larger than 16. For the statically defined DFHRPL, this will be the number of data sets in the concatenation, and can be a value larger than 16.
-
getSearchPosition
java.lang.Long getSearchPosition()
Getter for field SEARCHPOSSearch position
The current absolute position of this LIBRARY in the overall LIBRARY search order. The first LIBRARY in the search order will have a SEARCHPOS of 1, the next LIBRARY will have a SEARCHPOS of 2, and so on. The SEARCHPOS is not the same as the ranking, although its value is determined by the relative ranking values of the various LIBRARY resources in the system. If the LIBRARY is disabled then the SEARCHPOS will be 0 indicating that the LIBRARY does not participate in the overall search.
-
getPgmloadcnt
java.lang.Long getPgmloadcnt()
Getter for field PGMLOADCNTProgram load count
The number of program loads from data sets in this LIBRARY.
-
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
ILibrary.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.
- SYSTEM - The resource was last changed by the CICS system. This applies to the static DFHRPL library.
- 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.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
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.
-
getInstallAgent
ILibrary.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.
- SYSTEM - The resource was last installed by the CICS system. This applies to the static DFHRPL library.
- GRPLIST - The resource was installed by GRPLIST INSTALL.
- BUNDLE - The resource was installed by a bundle deployment.
-
getBasdefinever
java.lang.Long getBasdefinever()
Getter for field BASDEFINEVERBAS resource definition version
The BAS version number of this definition.
-
getCICSObjectReference
ILibraryReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-