com.ibm.cics.model
Interface IFileDefinition

All Superinterfaces:
ICICSDefinition, ICICSObject, IDefinition
All Known Subinterfaces:
IMutableFileDefinition

public interface IFileDefinition
extends ICICSDefinition

generated from CICS resourcetable FILEDEF


Nested Class Summary
static class IFileDefinition.BackuptypeValue
          Enumeration type for field BACKUPTYPE
static class IFileDefinition.DispositionValue
          Enumeration type for field DISPOSITION
static class IFileDefinition.DsnsharingValue
          Enumeration type for field DSNSHARING
static interface IFileDefinition.FwdrecovlogValue
          Long constants interface for field FWDRECOVLOG
static class IFileDefinition.JnladdValue
          Enumeration type for field JNLADD
static class IFileDefinition.JnlreadValue
          Enumeration type for field JNLREAD
static interface IFileDefinition.JournalValue
          Long constants interface for field JOURNAL
static interface IFileDefinition.LsrpoolidValue
          Long constants interface for field LSRPOOLID
static interface IFileDefinition.MaxnumrecsValue
          Long constants interface for field MAXNUMRECS
static class IFileDefinition.OpentimeValue
          Enumeration type for field OPENTIME
static class IFileDefinition.ReadintegValue
          Enumeration type for field READINTEG
static class IFileDefinition.RecordFormatValue
          Enumeration type for field RECORDFORMAT
static class IFileDefinition.RecoveryValue
          Enumeration type for field RECOVERY
static class IFileDefinition.StatusValue
          Enumeration type for field STATUS
static class IFileDefinition.TableValue
          Enumeration type for field TABLE
static class IFileDefinition.UpdatemodelValue
          Enumeration type for field UPDATEMODEL
 
Method Summary
 ICICSEnums.YesNoValue getAdd()
          Getter for field ADD
 IFileDefinition.BackuptypeValue getBackuptype()
          Getter for field BACKUPTYPE
 ICICSEnums.YesNoValue getBrowse()
          Getter for field BROWSE
 java.lang.String getCsdgroup()
          Getter for field CSDGROUP
 java.lang.Long getDatabuffers()
          Getter for field DATABUFFERS
 ICICSEnums.YesNoValue getDelete()
          Getter for field DELETE
 IFileDefinition.DispositionValue getDisposition()
          Getter for field DISPOSITION
 java.lang.String getDsname()
          Getter for field DSNAME
 IFileDefinition.DsnsharingValue getDsnsharing()
          Getter for field DSNSHARING
 java.lang.Long getFwdrecovlog()
          Getter for field FWDRECOVLOG
 java.lang.Long getIndexbuffers()
          Getter for field INDEXBUFFERS
 IFileDefinition.JnladdValue getJnladd()
          Getter for field JNLADD
 IFileDefinition.JnlreadValue getJnlread()
          Getter for field JNLREAD
 ICICSEnums.YesNoValue getJnlsyncread()
          Getter for field JNLSYNCREAD
 ICICSEnums.YesNoValue getJnlsyncwrite()
          Getter for field JNLSYNCWRITE
 ICICSEnums.YesNoValue getJnlupdate()
          Getter for field JNLUPDATE
 java.lang.Long getJournal()
          Getter for field JOURNAL
 java.lang.Long getKeylength()
          Getter for field KEYLENGTH
 ICICSEnums.YesNoValue getLoadtype()
          Getter for field LOADTYPE
 java.lang.Long getLsrpoolid()
          Getter for field LSRPOOLID
 java.lang.Long getMaxnumrecs()
          Getter for field MAXNUMRECS
 java.lang.String getNsrgroup()
          Getter for field NSRGROUP
 IFileDefinition.OpentimeValue getOpentime()
          Getter for field OPENTIME
 java.lang.String getPassword()
          Getter for field PASSWORD
 java.lang.String getPoolname()
          Getter for field POOLNAME
 ICICSEnums.YesNoValue getRead()
          Getter for field READ
 IFileDefinition.ReadintegValue getReadinteg()
          Getter for field READINTEG
 IFileDefinition.RecordFormatValue getRecordFormat()
          Getter for field RECORDFORMAT
 java.lang.Long getRecordsize()
          Getter for field RECORDSIZE
 IFileDefinition.RecoveryValue getRecovery()
          Getter for field RECOVERY
 java.lang.String getRemotename()
          Getter for field REMOTENAME
 java.lang.String getRemotesystem()
          Getter for field REMOTESYSTEM
 ICICSEnums.YesNoValue getRlsaccess()
          Getter for field RLSACCESS
 IFileDefinition.StatusValue getStatus()
          Getter for field STATUS
 java.lang.Long getStrings()
          Getter for field STRINGS
 IFileDefinition.TableValue getTable()
          Getter for field TABLE
 java.lang.String getTablename()
          Getter for field TABLENAME
 ICICSEnums.YesNoValue getUpdate()
          Getter for field UPDATE
 IFileDefinition.UpdatemodelValue getUpdatemodel()
          Getter for field UPDATEMODEL
 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, getDescription, getVersion
 
Methods inherited from interface com.ibm.cics.model.IDefinition
getName
 

Method Detail

getAdd

ICICSEnums.YesNoValue getAdd()
Getter for field ADD

Add option

Specifies whether records can be added to the file.


getBrowse

ICICSEnums.YesNoValue getBrowse()
Getter for field BROWSE

Browse option

Specifies whether records can be retrieved sequentially from the file.


getDelete

ICICSEnums.YesNoValue getDelete()
Getter for field DELETE

Delete option

Specifies whether records can be deleted from the file.


getRead

ICICSEnums.YesNoValue getRead()
Getter for field READ

Read option

Specifies whether records on this file can be read.


getUpdate

ICICSEnums.YesNoValue getUpdate()
Getter for field UPDATE

Update option

Specifies whether records on this file can be updated.


getBackuptype

IFileDefinition.BackuptypeValue getBackuptype()
Getter for field BACKUPTYPE

CICS VSAM file backup type

CICS VSAM files can be defined as eligible for backup while open for update. Possible values are:


getDatabuffers

java.lang.Long getDatabuffers()
Getter for field DATABUFFERS

Number of data buffers

The number of buffers to be used for data. Use a value in the range 2 (the default) through 32767. The minimum value you may specify is one more than the number of strings defined in the STRINGS attribute. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.


getDisposition

IFileDefinition.DispositionValue getDisposition()
Getter for field DISPOSITION

Disposition of file

The disposition of this file:


getDsnsharing

IFileDefinition.DsnsharingValue getDsnsharing()
Getter for field DSNSHARING

VSAM data set name sharing

Specifies whether VSAM data set name sharing is used for the VSAM file. The possible values are:


getFwdrecovlog

java.lang.Long getFwdrecovlog()
Getter for field FWDRECOVLOG

Journal number used for forward recovery

The journal that corresponds to the MVS system logger log stream that is to be used for forward recovery. This attribute is ignored for coupling facility data tables and, if there are any recovery attributes defined in the ICF catalog for a source data set associated with the table, these also are ignored. A CFDT is not forward recoverable.


getIndexbuffers

java.lang.Long getIndexbuffers()
Getter for field INDEXBUFFERS

Number of index buffers

The number of buffers to be used for the index. Use a value in the range 1 through 32767. The minimum value you may specify is the number of strings defined in the STRINGS attribute. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.


getJnladd

IFileDefinition.JnladdValue getJnladd()
Getter for field JNLADD

Add operations recorded on journal

The add operations you want recorded on the journal nominated by the JOURNAL attribute. Possible values are:


getJnlread

IFileDefinition.JnlreadValue getJnlread()
Getter for field JNLREAD

Read operations recorded on journal

The read operations you want recorded on the journal nominated by the JOURNAL attribute. Possible values are:


getJnlsyncread

ICICSEnums.YesNoValue getJnlsyncread()
Getter for field JNLSYNCREAD

Synchronous auto journaling for input

Specifies whether you want the automatic journaling records, written for READ operations to the journal specified by JOURNAL, to be written synchronously or asynchronously.


getJnlsyncwrite

ICICSEnums.YesNoValue getJnlsyncwrite()
Getter for field JNLSYNCWRITE

Synchronous auto journaling for output

Specifies whether you want the automatic journaling records, written for WRITE operations to the journal specified by JOURNAL, to be written synchronously or asynchronously.


getJnlupdate

ICICSEnums.YesNoValue getJnlupdate()
Getter for field JNLUPDATE

Rewrite/delete operations recorded on journal

Specifies whether you want REWRITE and DELETE operations recorded on the journal nominated by the JOURNAL attribute.


getJournal

java.lang.Long getJournal()
Getter for field JOURNAL

Journal number

Specifies whether you want automatic journaling for this file. The journaled data is in the format of the VSAM record and is used for user controlled journaling. The data to be journaled is identified by the JNLADD, JNLREAD, JNLSYNCREAD, JNLSYNCWRITE, and JNLUPDATE attributes. Possible values are:


getKeylength

java.lang.Long getKeylength()
Getter for field KEYLENGTH

Key length

The length in bytes of the logical key of records in remote files, and in coupling facility data tables that are specified with LOAD(NO). If KEYLENGTH is not defined here, the KEYLENGTH option must be specified on file control commands in the application programs that refer to this file. If KEYLENGTH is not defined here and not specified in the application program, and the key is longer than 4 characters, the default value is 4.


getLsrpoolid

java.lang.Long getLsrpoolid()
Getter for field LSRPOOLID

Local shared resources pool ID

The identity of the local shared resource pool. The default value for LSRPOOLID is 1, unless a value has been specified for the NSRGROUP attribute, in which case the default value for LSRPOOLID is NONE. Options are:


getMaxnumrecs

java.lang.Long getMaxnumrecs()
Getter for field MAXNUMRECS

Maximum number of records in data table

For CICS and USER tables, the maximum number of entries in the data table, in the range 1 through 99999999. If NOLIMIT is specified the number of entries is unlimited. NOLIMIT is the default value.


getNsrgroup

java.lang.String getNsrgroup()
Getter for field NSRGROUP

Non-shared resources (NSR) group name

For files referencing data sets that use VSAM non-shared resources (NSR), a 1- to 8-character symbolic name to group together file definitions that refer to the same VSAM base data set.


getOpentime

IFileDefinition.OpentimeValue getOpentime()
Getter for field OPENTIME

File open time

Specifies when the file is opened. Possible values are


getPassword

java.lang.String getPassword()
Getter for field PASSWORD

User access password

The 1-to 8-character password that is used to verify user access to the file.


getReadinteg

IFileDefinition.ReadintegValue getReadinteg()
Getter for field READINTEG

Default level of read integrity

The level of read integrity required for files defined with RLSACCESS(YES):


getRecordFormat

IFileDefinition.RecordFormatValue getRecordFormat()
Getter for field RECORDFORMAT

Record format

The format of the records on the file:


getRecordsize

java.lang.Long getRecordsize()
Getter for field RECORDSIZE

Record size

The maximum length in bytes of records in a remote file . The size specified can be in the range 1 through 32767.


getRecovery

IFileDefinition.RecoveryValue getRecovery()
Getter for field RECOVERY

Type of recovery

The type of recovery required for the file:


getRemotename

java.lang.String getRemotename()
Getter for field REMOTENAME

Remote file name

(Optional.) Specifies, if the file resides on a remote system, the name by which this file is known in the system or region in which it is resident. The name can be up to eight characters in length.


getRemotesystem

java.lang.String getRemotesystem()
Getter for field REMOTESYSTEM

Remote system name

(Optional.) Specifies, if the file resides on a remote system, the name of the connection that links the target (local) system to the related (remote) system where the file resides. If this attribute is not supplied, this is derived directly from the CICS system ID of the related system. The connection that links the target system to the related system must have the same name as the CICS system ID of the related system.


getRlsaccess

ICICSEnums.YesNoValue getRlsaccess()
Getter for field RLSACCESS

Record level sharing (RLS) file access mode

Specifies whether CICS is to open the file in RLS mode:


getStatus

IFileDefinition.StatusValue getStatus()
Getter for field STATUS

Initial status

The initial status of the file following a CICS initialization with START=COLD or START=INITIAL. Options are:


getStrings

java.lang.Long getStrings()
Getter for field STRINGS

Maximum concurrent requests against file

The number, in the range 1 through 255, of concurrent requests that can be processed against the file. If you leave this field blank, CICSPlex SM uses the default value for your CICS environment, if there is one.


getTable

IFileDefinition.TableValue getTable()
Getter for field TABLE

Data table type

Indicates whether a file represents a data table: Values are:


getDsname

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

Data set name

The data set name (as known to the operating system) to be used for this file. DSNAME can be 1 through 44 characters, conforming to the rules for MVS data set names.


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.


getPoolname

java.lang.String getPoolname()
Getter for field POOLNAME

Coupling facility data table (CFDT) pool name

The name of the coupling facility data table pool in which the coupling facility data table resides.


getTablename

java.lang.String getTablename()
Getter for field TABLENAME

Table name

The 8-character table name specified for the coupling facility data table on the file resource definition or the file name if the table name is omitted from the file resource definition. This is blank if the file does not refer to a coupling facility data table.


getUpdatemodel

IFileDefinition.UpdatemodelValue getUpdatemodel()
Getter for field UPDATEMODEL

Update model

The type of update model to be used for a coupling facility data table:


getLoadtype

ICICSEnums.YesNoValue getLoadtype()
Getter for field LOADTYPE

Load type

The load type for a coupling facility data table. The values are:


getCsdgroup

java.lang.String getCsdgroup()
Getter for field CSDGROUP

CSD group

The name of the CSD group for this CICS resource definition. This field is ignored for BAS definitions.



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