com.ibm.cics.model
Interface ILibrary

All Superinterfaces:
ICICSObject, ICICSResource, IInstalledCICSResource, com.ibm.cics.model.meta.ITypedObject

public interface ILibrary
extends ICICSResource, IInstalledCICSResource

generated from CICS resourcetable LIBRARY


Nested Class Summary
static class ILibrary.ChangeAgentValue
          Enumeration type for field CHANGEAGENT
static class ILibrary.CriticalStatusValue
          Enumeration type for field CRITSTATUS
static class ILibrary.EnableStatusValue
          Enumeration type for field ENABLESTATUS
static class ILibrary.InstallAgentValue
          Enumeration type for field INSTALLAGENT
 
Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.Long getBasdefinever()
          Getter for field BASDEFINEVER
 ILibrary.ChangeAgentValue getChangeAgent()
          Getter for field CHANGEAGENT
 java.lang.String getChangeAgentRelease()
          Getter for field CHANGEAGREL
 java.util.Date getChangeTime()
          Getter for field CHANGETIME
 java.lang.String getChangeUserID()
          Getter for field CHANGEUSRID
 ILibrary.CriticalStatusValue getCriticalStatus()
          Getter for field CRITSTATUS
 java.lang.String getDefineSource()
          Getter for field DEFINESOURCE
 java.util.Date getDefineTime()
          Getter for field DEFINETIME
 ILibrary.EnableStatusValue getEnableStatus()
          Getter for field ENABLESTATUS
 ILibrary.InstallAgentValue getInstallAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallUserID()
          Getter for field INSTALLUSRID
 java.lang.String getName()
          Getter for field NAME
 java.lang.Long getNumdsnames()
          Getter for field NUMDSNAMES
 java.lang.Long getPgmloadcnt()
          Getter for field PGMLOADCNT
 java.lang.Long getRanking()
          Getter for field RANKING
 java.lang.Long getSearchPosition()
          Getter for field SEARCHPOS
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getObjectType
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Getter for field NAME

LIBRARY name

The name of the LIBRARY.

Specified by:
getName in interface ICICSObject

getRanking

java.lang.Long getRanking()
Getter for field RANKING

Ranking

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:


getCriticalStatus

ILibrary.CriticalStatusValue getCriticalStatus()
Getter for field CRITSTATUS

Critical 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 ENABLESTATUS

Enable 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 NUMDSNAMES

Number 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 SEARCHPOS

Search 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 PGMLOADCNT

Program load count

The number of program loads from data sets in this LIBRARY.


getChangeUserID

java.lang.String getChangeUserID()
Getter for field CHANGEUSRID

Last modification user ID

The user ID that made the last modification to the resource definition.


getChangeAgent

ILibrary.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENT

Last modification agent

The change agent identifier that made the last modification.


getChangeAgentRelease

java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGREL

Last 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 CHANGETIME

Last modification time

The local date and time when the definition was last changed.


getDefineSource

java.lang.String getDefineSource()
Getter for field DEFINESOURCE

Source 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 DEFINETIME

Creation 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 INSTALLUSRID

Installation user ID

The user ID that installed the resource definition.


getInstallTime

java.util.Date getInstallTime()
Getter for field INSTALLTIME

Installation time

The local date and time when the definition was installed.


getInstallAgent

ILibrary.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENT

Installation agent

The install agent identifier that made the installation.


getBasdefinever

java.lang.Long getBasdefinever()
Getter for field BASDEFINEVER

BAS resource definition version

The BAS version number of this definition.



Copyright © 2008-2012 IBM Corp. All Rights Reserved.