com.ibm.cics.model
Interface ILibraryDefinition

All Superinterfaces:
ICICSDefinition, ICICSObject, IDefinition, com.ibm.cics.model.meta.ITypedObject

public interface ILibraryDefinition
extends ICICSDefinition

generated from CICS resourcetable LIBDEF


Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,ILibraryDefinition> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 ICICSDefinitionReference<ILibraryDefinition> getCICSObjectReference()
           
 ICICSEnums.YesNoValue getCritical()
          Getter for field CRITICAL
 java.lang.String getDsname01()
          Getter for field DSNAME01
 java.lang.String getDsname02()
          Getter for field DSNAME02
 java.lang.String getDsname03()
          Getter for field DSNAME03
 java.lang.String getDsname04()
          Getter for field DSNAME04
 java.lang.String getDsname05()
          Getter for field DSNAME05
 java.lang.String getDsname06()
          Getter for field DSNAME06
 java.lang.String getDsname07()
          Getter for field DSNAME07
 java.lang.String getDsname08()
          Getter for field DSNAME08
 java.lang.String getDsname09()
          Getter for field DSNAME09
 java.lang.String getDsname10()
          Getter for field DSNAME10
 java.lang.String getDsname11()
          Getter for field DSNAME11
 java.lang.String getDsname12()
          Getter for field DSNAME12
 java.lang.String getDsname13()
          Getter for field DSNAME13
 java.lang.String getDsname14()
          Getter for field DSNAME14
 java.lang.String getDsname15()
          Getter for field DSNAME15
 java.lang.String getDsname16()
          Getter for field DSNAME16
 ICICSType<ILibraryDefinition> getObjectType()
           
 java.lang.Long getRanking()
          Getter for field RANKING
 ICICSEnums.EnablementValue getStatus()
          Getter for field STATUS
 java.lang.String getUserdata1()
          Getter for field USERDATA1
 java.lang.String getUserdata2()
          Getter for field USERDATA2
 java.lang.String getUserdata3()
          Getter for field USERDATA3
 
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime, getCSDGroup, getDescription, getVersion
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

ICICSType<ILibraryDefinition> getObjectType()
Specified by:
getObjectType in interface ICICSDefinition
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface IDefinition
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

getCritical

ICICSEnums.YesNoValue getCritical()
Getter for field CRITICAL

Critical status

Specifies whether the LIBRARY is critical to the startup of CICS. Values are:

YES
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.
NO
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.


getStatus

ICICSEnums.EnablementValue getStatus()
Getter for field STATUS

Enabled 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.
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.


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:


getDsname01

java.lang.String getDsname01()
Getter for field DSNAME01

Data set name 01

The first data set in the concatenation, if specified. This must be a valid 44-character fully qualified disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distributed across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname02

java.lang.String getDsname02()
Getter for field DSNAME02

Data set name 02

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname03

java.lang.String getDsname03()
Getter for field DSNAME03

Data set name 03

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname04

java.lang.String getDsname04()
Getter for field DSNAME04

Data set name 04

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname05

java.lang.String getDsname05()
Getter for field DSNAME05

Data set name 05

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname06

java.lang.String getDsname06()
Getter for field DSNAME06

Data set name 06

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname07

java.lang.String getDsname07()
Getter for field DSNAME07

Data set name 07

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname08

java.lang.String getDsname08()
Getter for field DSNAME08

Data set name 08

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname09

java.lang.String getDsname09()
Getter for field DSNAME09

Data set name 09

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname10

java.lang.String getDsname10()
Getter for field DSNAME10

Data set name 10

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname11

java.lang.String getDsname11()
Getter for field DSNAME11

Data set name 11

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname12

java.lang.String getDsname12()
Getter for field DSNAME12

Data set name 12

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname13

java.lang.String getDsname13()
Getter for field DSNAME13

Data set name 13

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname14

java.lang.String getDsname14()
Getter for field DSNAME14

Data set name 14

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname15

java.lang.String getDsname15()
Getter for field DSNAME15

Data set name 15

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getDsname16

java.lang.String getDsname16()
Getter for field DSNAME16

Data set name 16

The next data set in the concatenation, if specified, or first if no previous DSNAMEnn is specified. This must be a valid 44-character fully qualified dataset name, and a disposition status of SHR is assumed. At least one DSNAMEnn must be specified, but this does not have to use the first position (DSNAME01), and the data set names can be distribute across the DSNAME01 to DSNAME16 attributes in a way which would make it easy to insert additional data set names into the definition.


getUserdata1

java.lang.String getUserdata1()
Getter for field USERDATA1

User 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 USERDATA2

User 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 USERDATA3

User 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<ILibraryDefinition> getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSDefinition
Specified by:
getCICSObjectReference in interface ICICSObject
Specified by:
getCICSObjectReference in interface IDefinition

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,ILibraryDefinition> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. The list factory can be activated by the caller when necessary. This method does not perform any I/O.



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