|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ILocalFile
generated from CICS resourcetable LOCFILE
Nested Class Summary | |
---|---|
static class |
ILocalFile.AccessMethodValue
Enumeration type for field ACCESSMETHOD |
static class |
ILocalFile.AddValue
Enumeration type for field ADD |
static class |
ILocalFile.BlockFormatValue
Enumeration type for field BLOCKFORMAT |
static class |
ILocalFile.BrowseValue
Enumeration type for field BROWSE |
static class |
ILocalFile.ChangeAgentValue
Enumeration type for field CHANGEAGENT |
static class |
ILocalFile.DeleteValue
Enumeration type for field DELETE |
static class |
ILocalFile.DispositionValue
Enumeration type for field DISPOSITION |
static class |
ILocalFile.DSTypeValue
Enumeration type for field OBJECT |
static class |
ILocalFile.EmptyStatusValue
Enumeration type for field EMPTYSTATUS |
static class |
ILocalFile.ExclusiveValue
Enumeration type for field EXCLUSIVE |
static class |
ILocalFile.ForwardRecoveryStatusValue
Enumeration type for field FWDRECSTATUS |
static class |
ILocalFile.InstallAgentValue
Enumeration type for field INSTALLAGENT |
static class |
ILocalFile.OpenStatusValue
Enumeration type for field OPENSTATUS |
static class |
ILocalFile.RBATypeValue
Enumeration type for field RBATYPE |
static class |
ILocalFile.ReadIntegrityValue
Enumeration type for field READINTEG |
static class |
ILocalFile.ReadValue
Enumeration type for field READ |
static class |
ILocalFile.RecordFormatValue
Enumeration type for field RECORDFORMAT |
static class |
ILocalFile.RecoveryStatusValue
Enumeration type for field RECOVSTATUS |
static class |
ILocalFile.RelativeAddressingTypeValue
Enumeration type for field RELTYPE |
static class |
ILocalFile.RLSAccessTypeValue
Enumeration type for field RLSACCESS |
static class |
ILocalFile.StatusValue
Enumeration type for field ENABLESTATUS |
static class |
ILocalFile.UpdateValue
Enumeration type for field UPDATE |
static class |
ILocalFile.VSAMTypeValue
Enumeration type for field VSAMTYPE |
Method Summary | |
---|---|
ILocalFile.AccessMethodValue |
getAccessMethod()
Getter for field ACCESSMETHOD |
java.lang.Long |
getActiveStringCount()
Getter for field NUMACTSTRING |
ILocalFile.AddValue |
getAdd()
Getter for field ADD |
java.lang.Long |
getAddCount()
Getter for field ADDCNT |
java.lang.Long |
getBasdefinever()
Getter for field BASDEFINEVER |
java.lang.String |
getBaseDSName()
Getter for field BASEDSNAME |
ILocalFile.BlockFormatValue |
getBlockFormat()
Getter for field BLOCKFORMAT |
java.lang.Long |
getBlockKeyLength()
Getter for field BLOCKKEYLN |
java.lang.Long |
getBlockSize()
Getter for field BLOCKSIZE |
ILocalFile.BrowseValue |
getBrowse()
Getter for field BROWSE |
java.lang.Long |
getBrowseCount()
Getter for field BROWSECNT |
java.lang.Long |
getBrowseUpdateCount()
Getter for field BROWUPDCNT |
ILocalFile.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 |
java.lang.String |
getCloseTime()
Getter for field TIMECLOSE |
java.lang.Long |
getDataBuffers()
Getter for field NUMDATBUFF |
java.lang.Long |
getDataOperationCount()
Getter for field DEXCPCNT |
java.lang.String |
getDefineSource()
Getter for field DEFINESOURCE |
java.util.Date |
getDefineTime()
Getter for field DEFINETIME |
ILocalFile.DeleteValue |
getDelete()
Getter for field DELETE |
ILocalFile.DispositionValue |
getDisposition()
Getter for field DISPOSITION |
java.lang.String |
getDSName()
Getter for field DSNAME |
java.lang.String |
getDSRecordType()
Getter for field DATASETTYPE |
ILocalFile.DSTypeValue |
getDSType()
Getter for field OBJECT |
ILocalFile.EmptyStatusValue |
getEmptyStatus()
Getter for field EMPTYSTATUS |
ILocalFile.ExclusiveValue |
getExclusive()
Getter for field EXCLUSIVE |
ILocalFile.ForwardRecoveryStatusValue |
getForwardRecoveryStatus()
Getter for field FWDRECSTATUS |
java.lang.String |
getGMTCloseTime()
Getter for field GMTFILECLS |
java.lang.String |
getGMTOpenTime()
Getter for field GMTFILEOPN |
java.lang.Long |
getIndexBuffers()
Getter for field NUMINDEXBUFF |
java.lang.Long |
getIndexOperationCount()
Getter for field IEXCPCNT |
ILocalFile.InstallAgentValue |
getInstallAgent()
Getter for field INSTALLAGENT |
java.util.Date |
getInstallTime()
Getter for field INSTALLTIME |
java.lang.String |
getInstallUserID()
Getter for field INSTALLUSRID |
java.lang.Long |
getJournalID()
Getter for field JOURNALNUM |
java.lang.Long |
getKeyLength()
Getter for field KEYLENGTH |
java.lang.Long |
getKeyPosition()
Getter for field KEYPOSITION |
java.lang.Long |
getLocalDeleteCount()
Getter for field LOCDELCNT |
java.lang.String |
getLSRPoolID()
Getter for field LSRPOOLID |
java.lang.String |
getName()
Getter for field FILE |
ILocalFile.OpenStatusValue |
getOpenStatus()
Getter for field OPENSTATUS |
java.lang.String |
getOpenTime()
Getter for field TIMEOPEN |
java.lang.Long |
getPeakStringWaitCount()
Getter for field WSTRCCURCNT |
ILocalFile.RBATypeValue |
getRBAType()
Getter for field RBATYPE |
ILocalFile.ReadValue |
getRead()
Getter for field READ |
java.lang.Long |
getReadCount()
Getter for field GETCNT |
ILocalFile.ReadIntegrityValue |
getReadIntegrity()
Getter for field READINTEG |
java.lang.Long |
getReadUpdateCount()
Getter for field GETUPDCNT |
ILocalFile.RecordFormatValue |
getRecordFormat()
Getter for field RECORDFORMAT |
java.lang.Long |
getRecordSize()
Getter for field RECORDSIZE |
ILocalFile.RecoveryStatusValue |
getRecoveryStatus()
Getter for field RECOVSTATUS |
ILocalFile.RelativeAddressingTypeValue |
getRelativeAddressingType()
Getter for field RELTYPE |
ILocalFile.RLSAccessTypeValue |
getRLSAccessType()
Getter for field RLSACCESS |
java.lang.Long |
getRLSTimeoutCount()
Getter for field RLSREQWTTO |
ILocalFile.StatusValue |
getStatus()
Getter for field ENABLESTATUS |
java.lang.Long |
getStringCount()
Getter for field STRINGS |
java.lang.Long |
getStringWaitCount()
Getter for field NUMSTRINGWT |
java.lang.Long |
getTotalStringWaitCount()
Getter for field WSTRCNT |
ILocalFile.UpdateValue |
getUpdate()
Getter for field UPDATE |
java.lang.Long |
getUpdateCount()
Getter for field UPDATECNT |
ILocalFile.VSAMTypeValue |
getVSAMType()
Getter for field VSAMTYPE |
Methods inherited from interface com.ibm.cics.model.ICICSResource |
---|
getCICSRelease, getRegionName |
Method Detail |
---|
java.lang.String getName()
File ID
The name of the file.
getName
in interface ICICSObject
ILocalFile.AccessMethodValue getAccessMethod()
Access method
The access method used for this file: BDAM or VSAM
ILocalFile.AddValue getAdd()
Add option
Indicates whether new records can be added to the file
Input Values: ADDABLE, NOTADDABLE
java.lang.String getBaseDSName()
Base data set name
For a file defined to CICS as a path, the name of the VSAM base data set. For a file defined as a base, this name is the same as the primary data set name.
ILocalFile.BlockFormatValue getBlockFormat()
Block format (BDAM only)
Indicates whether records on the file are blocked or unblocked
java.lang.Long getBlockKeyLength()
Block key length (BDAM only)
For BDAM files, the physical block key length as a decimal number in the range 1 - 255. A value of N/A means the file is not a BDAM file.
java.lang.Long getBlockSize()
Block size (BDAM only)
For BDAM files, the length of a block in bytes. If the blocks are variable-length or are undefined, the value displayed is the maximum block size. A value of N/A means the file is not a BDAM file.
ILocalFile.BrowseValue getBrowse()
Browse option
Indicates whether records can be sequentially retrieved from the file.
Input Values: BROWSABLE, NOTBROWSABLE
ILocalFile.DeleteValue getDelete()
Delete option
For VSAM files, indicates whether records can be deleted from the file.
Input Values: DELETABLE, NOTDELETABLE
ILocalFile.DispositionValue getDisposition()
Disposition of file
The disposition of the file.
Input Values: OLD, SHARE
java.lang.String getDSName()
Data set name
The name of the data set
ILocalFile.EmptyStatusValue getEmptyStatus()
Empty status
For VSAM files, indicates whether the data set is to be made empty the next time a file that references it is opened (EMPTYREQ or NOEMPTYREQ). This option is valid only for data sets that have been defined as reusable and defined to be used in non-RLS mode.
Input Values: EMPTYREQ, NOEMPTYREQ
ILocalFile.StatusValue getStatus()
Enablement status
Indicates whether the local file is available for access by application programs. The status will be one of the following:
Input Values: ENABLED, DISABLED
ILocalFile.ExclusiveValue getExclusive()
BDAM exclusive control status
For BDAM files, indicates whether records on the file are placed under exclusive control when a read for update is issued
Input Values: EXCTL, NOEXCTL, NOTAPPLIC
ILocalFile.ForwardRecoveryStatusValue getForwardRecoveryStatus()
Forward recovery option
Indicates, for VSAM files, whether the file is forward-recoverable (FWDRECOVABLE or NOTFWDRCVBLE).
java.lang.Long getKeyLength()
Key length
For local files associated with a VSAM KSDS, the length of the key. For local files associated with a BDAM data set, the length of the logical key used for deblocking. A value of 0 is returned if the file is not open.
java.lang.Long getKeyPosition()
Key position
The starting position of the key field in each record relative to the beginning of the record. A value of 0 is returned if the file is not open.
ILocalFile.DSTypeValue getDSType()
Data set type (base or path)
For VSAM files, indicates whether the file is related to a base data set (BASE) or is defined as a path that is accessed by means of an alternate index (PATH).
ILocalFile.OpenStatusValue getOpenStatus()
Open status
Indicates whether the file is open, closed, or in transition. The values are: OPEN, CLOSED, OPENING, CLOSING, CLOSEREQUEST.
Input Values: OPEN, CLOSED
ILocalFile.ReadValue getRead()
Read option
Indicates whether records can be read from the file.
Input Values: READABLE, NOTREADABLE
ILocalFile.RecordFormatValue getRecordFormat()
Record format
The format of the records on the file (FIXED, VARIABLE, or UNDEFINED).
java.lang.Long getRecordSize()
Record size
For fixed-length records, the actual size of a record. For variable-length records, the maximum size of a record. A value of 0 is returned if the file is not open.
ILocalFile.RecoveryStatusValue getRecoveryStatus()
Recovery status
Indicates whether the file is recoverable (RECOVERABLE or NOTRECOVABLE).
ILocalFile.RelativeAddressingTypeValue getRelativeAddressingType()
Relative addressing type (BDAM only)
For BDAM files, indicates whether relative or absolute addressing is used to access the file, and if relative, what type of relative addressing is being used in the block reference portion of the file's record identification field. The type is identified as one of the following:
java.lang.Long getStringCount()
Number of strings
For VSAM files, the number of concurrent operations that can be performed on the file. A value of N/A means the file is not a VSAM file.
Input Values: 1 - 255
ILocalFile.VSAMTypeValue getVSAMType()
Type of VSAM data set
Indicates how the records are organized in the data set associated with this file.
For VSAM files, the type is identified as one of the following:
For BDAM files, the type is either KEYED or NOTKEYED.
A value of NOTAPPLIC is returned if the file is not open.
ILocalFile.UpdateValue getUpdate()
Update option
Indicates whether records in the file can be updated.
Input Values: UPDATABLE, NOTUPDATABLE
java.lang.String getOpenTime()
Local time file was opened
The local time at which the file was opened.
java.lang.String getCloseTime()
Local time file was closed
The local time at which the file was closed.
java.lang.Long getReadCount()
Number of READ requests
The number of GET requests issued against this local file.
java.lang.Long getReadUpdateCount()
Number of READ UPDATE requests
The number of GET UPDATE requests issued against this local file.
java.lang.Long getBrowseCount()
The number of READNEXT and READPREV requests
The number of READNEXT and READPREV requests issued against the file.
java.lang.Long getAddCount()
Number of WRITE requests
The number of PUT requests issued against this local file.
java.lang.Long getUpdateCount()
Number of REWRITE requests
The number of PUT UPDATE requests issued against this local file.
java.lang.Long getLocalDeleteCount()
Number of DELETE requests
The number of DELETE requests issued against this local file.
java.lang.Long getDataOperationCount()
Number of I/O operations for data records
For VSAM files, the number of I/O operations on the file for data records.
java.lang.Long getIndexOperationCount()
Number of I/O operations against index component
For VSAM files, the number of I/O operations on the file for index records.
java.lang.Long getTotalStringWaitCount()
Total requests queued because all strings in use
The total number of requests that were queued because all the strings available to the file were in use.
java.lang.Long getJournalID()
Journal number
The ID of the journal associated with this file, in the range 1 - 99. An ID of 1 identifies the CICS system log. A value of 0 means no automatic journaling is being done because JID=NO was specified in the FCT entry.
java.lang.Long getPeakStringWaitCount()
Peak number of tasks waiting for a string
The peak number of requests that were queued at any one time because all the strings available to the file were in use.
java.lang.String getLSRPoolID()
Local shared resources pool ID
For VSAM files, the numeric ID of the LSR pool associated with the file.
A value of 0 means the file must not share buffers. A value of N/A means the file is not a VSAM file.
Input Values: 0 - 8
java.lang.Long getDataBuffers()
Number of data buffers
The number of buffers to be used for data.
java.lang.Long getIndexBuffers()
Number of index buffers
The number of buffers to be used for the index.
java.lang.Long getActiveStringCount()
Number of active strings
The current number of updates to the file.
java.lang.String getGMTOpenTime()
GMT file open time
The time at which the file was opened.
java.lang.String getGMTCloseTime()
GMT file close time
The time at which the file was closed.
java.lang.Long getStringWaitCount()
Current number of string waits
The current number of requests that are queued because all the strings available to the file were in use
java.lang.String getDSRecordType()
Data set type
Indicates how the records are organized in the data set associated with the file. For VSAM files, the type is identified as one of the following:
java.lang.Long getBrowseUpdateCount()
Number of browse for update requests
The number of GET NEXT, GET PREV, and PUT UPDATE requests issued against this local file.
ILocalFile.ReadIntegrityValue getReadIntegrity()
Default level of read integrity
The default level of read integrity active for the file, if a read integrity option is not explicitly coded on an API FILE READ command. The levels are:
ILocalFile.RLSAccessTypeValue getRLSAccessType()
Record level sharing (RLS) file access mode
Indicates whether a file is accessed in RLS mode. The values are:
Input Values: RLS, NOTRLS
java.lang.Long getRLSTimeoutCount()
Record level sharing (RLS) request wait timeouts
The number of RLS file requests that have timed out while awaiting request completion from the VSAM RLS server.
ILocalFile.RBATypeValue getRBAType()
Type of VSAM extended addressing
Indicates whether, for VSAM files, the data set uses extended addressing. The values are:
java.lang.String getChangeUserID()
Last modification user ID
The user ID that made the last modification to the resource definition.
ILocalFile.ChangeAgentValue getChangeAgent()
Last modification agent
The change agent identifier that made the last modification.
java.lang.String getChangeAgentRelease()
Last modification agent release
The CICS release level of the agent that made the last modification to the resource definition.
java.util.Date getChangeTime()
Last modification time
The local date and time when the definition was last changed.
java.lang.String getDefineSource()
Source of the resource definition
The source of the definition, depending on which agent made the last change.
java.util.Date getDefineTime()
Creation time
The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
java.lang.String getInstallUserID()
Installation user ID
The user ID that installed the resource definition.
java.util.Date getInstallTime()
Installation time
The local date and time when the definition was installed.
ILocalFile.InstallAgentValue getInstallAgent()
Installation agent
The change agent identifier that made the installation.
java.lang.Long getBasdefinever()
BAS resource definition version
The BAS version number of this definition.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |