Interface IFileDefinition
-
- All Superinterfaces:
ICICSDefinition
,ICICSObject
,IDefinition
,com.ibm.cics.model.meta.ITypedObject
public interface IFileDefinition extends ICICSDefinition
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IFileDefinition.BackuptypeValue
Enumeration type for field BACKUPTYPEstatic class
IFileDefinition.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
IFileDefinition.DispositionValue
Enumeration type for field DISPOSITIONstatic class
IFileDefinition.DsnsharingValue
Enumeration type for field DSNSHARINGstatic interface
IFileDefinition.FwdrecovlogValue
Long constants interface for field FWDRECOVLOGstatic class
IFileDefinition.JnladdValue
Enumeration type for field JNLADDstatic class
IFileDefinition.JnlreadValue
Enumeration type for field JNLREADstatic interface
IFileDefinition.JournalValue
Long constants interface for field JOURNALstatic interface
IFileDefinition.LsrpoolidValue
Long constants interface for field LSRPOOLIDstatic interface
IFileDefinition.MaxnumrecsValue
Long constants interface for field MAXNUMRECSstatic class
IFileDefinition.OpentimeValue
Enumeration type for field OPENTIMEstatic class
IFileDefinition.ReadintegValue
Enumeration type for field READINTEGstatic class
IFileDefinition.RecordFormatValue
Enumeration type for field RECORDFORMATstatic class
IFileDefinition.RecoveryValue
Enumeration type for field RECOVERYstatic class
IFileDefinition.StatusValue
Enumeration type for field STATUSstatic class
IFileDefinition.TableValue
Enumeration type for field TABLEstatic class
IFileDefinition.UpdatemodelValue
Enumeration type for field UPDATEMODEL
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSDefinition
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ICICSEnums.YesNoValue
getAdd()
Getter for field ADDIFileDefinition.BackuptypeValue
getBackuptype()
Getter for field BACKUPTYPEICICSEnums.YesNoValue
getBrowse()
Getter for field BROWSEIFileDefinition.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTICICSDefinitionReference<IFileDefinition>
getCICSObjectReference()
java.lang.Long
getDatabuffers()
Getter for field DATABUFFERSICICSEnums.YesNoValue
getDelete()
Getter for field DELETEIFileDefinition.DispositionValue
getDisposition()
Getter for field DISPOSITIONjava.lang.String
getDsname()
Getter for field DSNAMEIFileDefinition.DsnsharingValue
getDsnsharing()
Getter for field DSNSHARINGjava.lang.Long
getFwdrecovlog()
Getter for field FWDRECOVLOGjava.lang.Long
getIndexbuffers()
Getter for field INDEXBUFFERSIFileDefinition.JnladdValue
getJnladd()
Getter for field JNLADDIFileDefinition.JnlreadValue
getJnlread()
Getter for field JNLREADICICSEnums.YesNoValue
getJnlsyncread()
Getter for field JNLSYNCREADICICSEnums.YesNoValue
getJnlsyncwrite()
Getter for field JNLSYNCWRITEICICSEnums.YesNoValue
getJnlupdate()
Getter for field JNLUPDATEjava.lang.Long
getJournal()
Getter for field JOURNALjava.lang.Long
getKeylength()
Getter for field KEYLENGTHICICSEnums.YesNoValue
getLoadtype()
Getter for field LOADTYPEjava.lang.Long
getLsrpoolid()
Getter for field LSRPOOLIDjava.lang.Long
getMaxnumrecs()
Getter for field MAXNUMRECSjava.lang.String
getNsrgroup()
Getter for field NSRGROUPICICSType<IFileDefinition>
getObjectType()
IFileDefinition.OpentimeValue
getOpentime()
Getter for field OPENTIMEjava.lang.String
getPassword()
Getter for field PASSWORDjava.lang.String
getPoolname()
Getter for field POOLNAMEICICSEnums.YesNoValue
getRead()
Getter for field READIFileDefinition.ReadintegValue
getReadinteg()
Getter for field READINTEGIFileDefinition.RecordFormatValue
getRecordFormat()
Getter for field RECORDFORMATjava.lang.Long
getRecordsize()
Getter for field RECORDSIZEIFileDefinition.RecoveryValue
getRecovery()
Getter for field RECOVERYjava.lang.String
getRemotename()
Getter for field REMOTENAMEjava.lang.String
getRemotesystem()
Getter for field REMOTESYSTEMICICSEnums.YesNoValue
getRlsaccess()
Getter for field RLSACCESSIFileDefinition.StatusValue
getStatus()
Getter for field STATUSjava.lang.Long
getStrings()
Getter for field STRINGSIFileDefinition.TableValue
getTable()
Getter for field TABLEjava.lang.String
getTablename()
Getter for field TABLENAMEICICSEnums.YesNoValue
getUpdate()
Getter for field UPDATEIFileDefinition.UpdatemodelValue
getUpdatemodel()
Getter for field UPDATEMODELjava.lang.String
getUserdata1()
Getter for field USERDATA1java.lang.String
getUserdata2()
Getter for field USERDATA2java.lang.String
getUserdata3()
Getter for field USERDATA3-
Methods inherited from interface com.ibm.cics.model.ICICSDefinition
getChangeAgentRelease, getChangeTime, getChangeUserID, getCICSContainer, getCreateTime, getCSDGroup, getDescription, getVersion
-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IFileDefinition> getObjectType()
- Specified by:
getObjectType
in interfaceICICSDefinition
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceIDefinition
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getChangeAgent
IFileDefinition.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CSDBATCH - The resource was last changed by a DFHCSDUP job.
- DREPAPI - Resource was last changed by a CICSPlex SM API command.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getAdd
ICICSEnums.YesNoValue getAdd()
Getter for field ADDAdd option
Specifies whether records can be added to the file.
-
getBrowse
ICICSEnums.YesNoValue getBrowse()
Getter for field BROWSEBrowse option
Specifies whether records can be retrieved sequentially from the file.
-
getDelete
ICICSEnums.YesNoValue getDelete()
Getter for field DELETEDelete option
Specifies whether records can be deleted from the file.
-
getRead
ICICSEnums.YesNoValue getRead()
Getter for field READRead option
Specifies whether records on this file can be read.
-
getUpdate
ICICSEnums.YesNoValue getUpdate()
Getter for field UPDATEUpdate option
Specifies whether records on this file can be updated.
-
getBackuptype
IFileDefinition.BackuptypeValue getBackuptype()
Getter for field BACKUPTYPECICS VSAM file backup type
CICS VSAM files can be defined as eligible for backup while open for update. Possible values are:
- DYNAMIC - Specify this along with the RECOVERY attribute of ALL to make the file eligible for backup while open for update.
- STATIC - The file is not eligible for backup while open for update.
-
getDatabuffers
java.lang.Long getDatabuffers()
Getter for field DATABUFFERSNumber 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 DISPOSITIONDisposition of file
The disposition of this file:
- OLD - Equivalent to the DISP=OLD parameter in JCL.
- SHARE - Equivalent to the DISP=SHR parameter in JCL.
-
getDsnsharing
IFileDefinition.DsnsharingValue getDsnsharing()
Getter for field DSNSHARINGVSAM data set name sharing
Specifies whether VSAM data set name sharing is used for the VSAM file. The possible values are:
- ALLREQS - Data set name sharing is set in the ACB when the file is opened and is therefore used for all file requests.
- MODIFYREQS - Data set name sharing is set in the ACB when the file is opened only if an operation of DELETE, ADD, or UPDATE is set for the file.
-
getFwdrecovlog
java.lang.Long getFwdrecovlog()
Getter for field FWDRECOVLOGJournal 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.
- NO - Forward recovery logging is not required for this file.
- journal - The number that identifies the journal that CICS is to use for the forward recovery log. CICS journal names are of the form DFHJnn where nn is in the range 1 through 99. The after images for forward recovery are written to the MVS log stream that corresponds to journal name DFHJnn.
-
getIndexbuffers
java.lang.Long getIndexbuffers()
Getter for field INDEXBUFFERSNumber 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 JNLADDAdd operations recorded on journal
The add operations you want recorded on the journal nominated by the JOURNAL attribute. Possible values are:
- AFTER - Journal the file control write operation after the VSAM I/O operation.
- ALL - Journal the file control write operation both before and after the VSAM I/O operation has completed.
- BEFORE - Journal the file control write operation before the VSAM I/O operation.
- NONE - Do not journal add operations.
-
getJnlread
IFileDefinition.JnlreadValue getJnlread()
Getter for field JNLREADRead operations recorded on journal
The read operations you want recorded on the journal nominated by the JOURNAL attribute. Possible values are:
- ALL - Journal all read operations.
- NONE - Do not journal read operations.
- READONLY - Journal only READ ONLY operations (not READ UPDATE operations).
- UPDATEONLY - Journal only READ UPDATE operations (not READ ONLY operations).
-
getJnlsyncread
ICICSEnums.YesNoValue getJnlsyncread()
Getter for field JNLSYNCREADSynchronous 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 JNLSYNCWRITESynchronous 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 JNLUPDATERewrite/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 JOURNALJournal 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:
- NO - No automatic journaling is to take place for this file.
- number - The number that identifies the journal that CICS is to use for the autojournal. CICS journal names are of the form DFHJnn, where nn is in the range 1 through 99.
-
getKeylength
java.lang.Long getKeylength()
Getter for field KEYLENGTHKey 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 LSRPOOLIDLSR Pool number
The identity of the local shared resource pool. The default value for LSR Pool number is 1, unless a value has been specified for the NSRGROUP attribute, in which case the default value for LSR Pool number is NONE. Options are:
- NONE - Specifies that the data set associated with this file uses VSAM nonshared resources (NSR).
- number - The value, in the range 1 through 255, identifies the number of the VSAM shared resource pool that is used by the VSAM data set associated with this file. The data set is defined as using VSAM local shared resources (LSR). You are recommended to define the buffers, strings, and other resources explicitly in an LSRPOOL resource definition that corresponds to this LSR Pool number.
-
getMaxnumrecs
java.lang.Long getMaxnumrecs()
Getter for field MAXNUMRECSMaximum 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 NSRGROUPNon-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 OPENTIMEFile open time
Specifies when the file is opened. Possible values are
- FIRSTREF - The file remains closed until a request is made to open it by: a main terminal command, an EXEC CICS SET FILE OPEN command in an application program, or an implicit open.
- STARTUP - The file is opened immediately after CICS initialization by an automatically initiated CICS transaction (CSFU), unless the status of the file is UNENABLED, in which case the file is left closed.
-
getPassword
java.lang.String getPassword()
Getter for field PASSWORDUser access password
The 1-to 8-character password that is used to verify user access to the file. This attribute is obsolete from CICS Transaction Server 5.3 onwards.
-
getReadinteg
IFileDefinition.ReadintegValue getReadinteg()
Getter for field READINTEGDefault level of read integrity
The level of read integrity required for files defined with RLSACCESS(YES):
- CONSISTENT - The record is read with consistent read integrity. CONSISTENT is valid only if you also specify RLSACCESS(YES)-the resource definition is rejected with an error if you specify CONSISTENT for a non-RLS file.
- REPEATABLE - The record is read with repeatable read integrity.
- UNCOMMITTED - The record is read without read integrity. UNCOMMITTED is the same level of integrity that is provided by those releases of CICS that do not support the READINTEG attribute.
-
getRecordFormat
IFileDefinition.RecordFormatValue getRecordFormat()
Getter for field RECORDFORMATRecord format
The format of the records on the file:
- Fixed - The records are fixed length.
- Variable - The records are variable length.
-
getRecordsize
java.lang.Long getRecordsize()
Getter for field RECORDSIZERecord 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 RECOVERYType of recovery
The type of recovery required for the file:
- ALL - Before images are recorded in the system log, and after images in the journal specified in the FWDRECOVLOG attribute.
- BACKOUTONLY - Before images are recorded in the system log.
- NONE - There is no recovery logging for this file.
-
getRemotename
java.lang.String getRemotename()
Getter for field REMOTENAMERemote 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 REMOTESYSTEMRemote 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 RLSACCESSRecord level sharing (RLS) file access mode
Specifies whether CICS is to open the file in RLS mode:
- NO - The file is not to be opened in RLS mode.
- YES - The file is to be opened in RLS mode.
-
getStatus
IFileDefinition.StatusValue getStatus()
Getter for field STATUSInitial status
The initial status of the file following a CICS initialization with START=COLD or START=INITIAL. Options are:
- DISABLED - Any request against this file from a command-level application program causes the DISABLED condition to be passed to the program.
- ENABLED - Normal processing is allowed against this file.
- UNENABLED - This prevents the file being opened by an implicit open from an application program. Any such attempt to access the file raises the NOTOPEN condition. By contrast, an explicit request to open the file (for example, a CEMT or EXEC CICS SET FILE OPEN command) changes the status to ENABLED before attempting to open the file.
-
getStrings
java.lang.Long getStrings()
Getter for field STRINGSMaximum 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 TABLEData table type
Indicates whether a file represents a data table: Values are:
- NO - The file does not represent a data table.
- CICS - The file represents a CICS-maintained data table.
- USER - The file represents a user-maintained data table.
- CF - The file represents a coupling facility data table.
-
getDsname
java.lang.String getDsname()
Getter for field DSNAMEData 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 USERDATA1User 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 USERDATA2User 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 USERDATA3User 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 POOLNAMECoupling 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 TABLENAMETable 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 UPDATEMODELUpdate model
The type of update model to be used for a coupling facility data table:
- LOCKING - specifies that the CFDT is updated using the locking model.
- CONTENTION - specifies that the CFDT is updated using the contention model.
-
getLoadtype
ICICSEnums.YesNoValue getLoadtype()
Getter for field LOADTYPELoad type
The load type for a coupling facility data table. The values are:
- Load - The coupling facility data table is, or is to be, preloaded from a source data set.
- Noload - The coupling facility data table is not preloaded from a source data set.
-
getCICSObjectReference
ICICSDefinitionReference<IFileDefinition> getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSDefinition
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceIDefinition
-
-