com.ibm.cics.model
Interface ILibraryDSName

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

public interface ILibraryDSName
extends ICICSResource

generated from CICS resourcetable LIBDSN


Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,ILibraryDSName> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 ILibraryDSNameReference getCICSObjectReference()
           
 java.lang.String getDSName()
          Getter for field DSNAME
 java.lang.Long getDSNameSearchPosition()
          Getter for field DSNSEARCHPOS
 java.lang.Long getDSNumber()
          Getter for field DSNUM
 java.lang.String getName()
          Getter for field LIBRARY
 ICICSType<ILibraryDSName> getObjectType()
           
 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
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

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

getName

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

LIBRARY name

The name of the LIBRARY that contains this data set in its concatenation.

Specified by:
getName in interface ICICSObject

getDSNumber

java.lang.Long getDSNumber()
Getter for field DSNUM

LIBRARY data set number

The number of the dataset in the LIBRARY definition. For DFHRPL this number will be derived from the data set's relative offset from the beginning of the DFHRPL concatenation, starting at one. For LIBRARYs other than DFHRPL this number is the number at which the data set was defined, so this may not be sequential if data sets were not defined at every preceeding position.


getDSName

java.lang.String getDSName()
Getter for field DSNAME

Data set name

The name of a data set in the LIBRARY concatenation. If the LIBRARY is a dynamically defined LIBRARY, then this is a data set specified on the LIBRARY definition. If the LIBRARY is the statically defined DFHRPL, then this is a data set defined in the DFHRPL concatenation in the CICS startup JCL.


getDSNameSearchPosition

java.lang.Long getDSNameSearchPosition()
Getter for field DSNSEARCHPOS

Data set search enumerator

This value displays the relative position of the data set in the overall LIBRARY data set search order.

This value is obtained by combining the SEARCHPOS of this data set's LIBRARY with the data set's own DSNUM. If the LIBRARY is disabled then the LIBRARY SEARCHPOS will be 0, indicating that the LIBRARY does not participate in the overall search. In this case this field will be set to N/A.

Due to the way this value is calculated, the first data set to be searched will not have a data set search enumerator of 1, it will be 1001.


getSearchPosition

java.lang.Long getSearchPosition()
Getter for field SEARCHPOS

Search position

The current absolute position of this data set's 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.


getCICSObjectReference

ILibraryDSNameReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,ILibraryDSName> 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.