Rational Developer for Power Systems Software
V7.6

com.ibm.etools.iseries.comm.interfaces
Interface IISeriesHostFileDefinition

All Known Subinterfaces:
IQSYSDatabaseFile, IQSYSDataFile, IQSYSDDMFile, IQSYSLogicalFile, IQSYSPhysicalFile, IQSYSSourceFile
All Known Implementing Classes:
ISeriesHostFileDefinition, QSYSHostDatabaseFile, QSYSHostDataFile, QSYSHostDDMFile, QSYSHostLogicalFile, QSYSHostPhysicalFile, QSYSHostSourceFile, QSYSRemoteDatabaseFile, QSYSRemoteDataFile, QSYSRemoteDDMFile, QSYSRemoteLogicalFile, QSYSRemotePhysicalFile, QSYSRemoteSourceFile

public interface IISeriesHostFileDefinition

Interface representing the file definition for an iSeries database file. This interface corresponds to the format FILD0100 of the QDBRTVFD api.

See Also:
ISeriesRetrieveDatabaseFileDescription

Field Summary
static String ARRIVAL_SEQ
          Arrival sequence access path.
static String Copyright
           
static String ENCODED_VECTOR_SEQ
          Encoded vector with a 1-, 2-, or 4-byte vector.
static String KEYED_FCFO_SEQ
          Keyed sequence access path with duplicate keys allowed.
static String KEYED_FIFO_SEQ
          Keyed sequence access path with duplicate keys allowed.
static String KEYED_LIFO_SEQ
          Keyed sequence access path with duplicate keys allowed.
static String KEYED_NO_ORDER_SEQ
          Keyed sequence access path with duplicate keys allowed.
static String KEYED_UNIQUE_SEQ
          Keyed sequence access path with no duplicate keys allowed (UNIQUE).
 
Method Summary
 void addBasedOnFile(String library, String file, String record)
          Add a based on file to the list of based on files for this logical file.
 String getAccessPathType()
          Get the access path type.
 boolean getAlternateSequence()
          Check whether this record format uses an alternate collating sequence (ALTSEQ)
 int getBasedOnCount()
          Get the number of files this file is based on.
 List getBasedOnFiles()
          Return a list of the based on files
 boolean getDynamicSelect()
          Check whether this record format uses the dynamic selection indicator (DYNSLT).
 boolean getIGCField()
          Check whether this record format contains DBCS or Graphic data.
 boolean getIGCLiteral()
          Check whether this record format contains DBCS or Graphic literals.
 boolean getKeyedAccessPath()
          Check whether this record format has a keyed sequence access path.
 String getLangId()
          Get the language identifier
 boolean getSelectOmitLF()
          Check whether this file is a select/omit logical file.
 boolean isJoinLogicalFile()
          Check whether this record format is a join logical file
 boolean isSourceFile()
          Check whether this record format is source file.
 void setAccessPathType(String accessPathType)
          Set the access path type for this record format.
 void setAlternateSequence(boolean altSeq)
          Set whether this record format uses an alternate collating sequence (ALTSEQ)
 void setBasedOnCount(int count)
          Set the number of files this file is based on.
 void setDynamicSelect(boolean dynamicSelect)
          Set whether this record format uses the dynamic selection indicator (DYNSLT).
 void setIGCField(boolean igcField)
          Set whether this record format contains DBCS or Graphic data.
 void setIGCLiteral(boolean igcLiteral)
          Set whether this record format contains DBCS or Graphic literals.
 void setIsSourceFile(boolean sourceFile)
          Set whether this record format is source file or a data file.
 void setJoinLogicalFile(boolean logicalJoinFile)
          Set whether this record format is a join logical file
 void setKeyedAccessPath(boolean keyed)
          Set whether this record format has a keyed sequence access path.
 void setLangId(String langId)
          Set the language identifier
 void setSelectOmitLF(boolean selectOmitLF)
          Set whether this file is a select/omit logical file.
 

Field Detail

Copyright

static final String Copyright
See Also:
Constant Field Values

ARRIVAL_SEQ

static final String ARRIVAL_SEQ
Arrival sequence access path.

See Also:
Constant Field Values

KEYED_FCFO_SEQ

static final String KEYED_FCFO_SEQ
Keyed sequence access path with duplicate keys allowed. Duplicate keys are accessed in first-changed-first-out (FCFO) order.

See Also:
Constant Field Values

KEYED_FIFO_SEQ

static final String KEYED_FIFO_SEQ
Keyed sequence access path with duplicate keys allowed. Duplicate keys are accessed in first-in-first-out (FIFO) order.

See Also:
Constant Field Values

KEYED_LIFO_SEQ

static final String KEYED_LIFO_SEQ
Keyed sequence access path with duplicate keys allowed. Duplicate keys are accessed in last-in-first-out (LIFO) order.

See Also:
Constant Field Values

KEYED_NO_ORDER_SEQ

static final String KEYED_NO_ORDER_SEQ
Keyed sequence access path with duplicate keys allowed. No order is guaranteed when accessing duplicate keys.

See Also:
Constant Field Values

KEYED_UNIQUE_SEQ

static final String KEYED_UNIQUE_SEQ
Keyed sequence access path with no duplicate keys allowed (UNIQUE).

See Also:
Constant Field Values

ENCODED_VECTOR_SEQ

static final String ENCODED_VECTOR_SEQ
Encoded vector with a 1-, 2-, or 4-byte vector.

See Also:
Constant Field Values
Method Detail

getIGCField

boolean getIGCField()
                    throws Exception
Check whether this record format contains DBCS or Graphic data.

Throws:
Exception

getIGCLiteral

boolean getIGCLiteral()
                      throws Exception
Check whether this record format contains DBCS or Graphic literals.

Throws:
Exception

getAlternateSequence

boolean getAlternateSequence()
                             throws Exception
Check whether this record format uses an alternate collating sequence (ALTSEQ)

Throws:
Exception

getKeyedAccessPath

boolean getKeyedAccessPath()
                           throws Exception
Check whether this record format has a keyed sequence access path.

Throws:
Exception

getSelectOmitLF

boolean getSelectOmitLF()
                        throws Exception
Check whether this file is a select/omit logical file.

Throws:
Exception

getDynamicSelect

boolean getDynamicSelect()
                         throws Exception
Check whether this record format uses the dynamic selection indicator (DYNSLT). If on, the selection and omission tests specified for the file are done when the file is read. If off, when the access path is updated.

Throws:
Exception

getAccessPathType

String getAccessPathType()
                         throws Exception
Get the access path type.

Throws:
Exception
See Also:
ARRIVAL_SEQ, KEYED_FCFO_SEQ, KEYED_FIFO_SEQ, KEYED_LIFO_SEQ, KEYED_NO_ORDER_SEQ, KEYED_UNIQUE_SEQ, ENCODED_VECTOR_SEQ

getBasedOnCount

int getBasedOnCount()
                    throws Exception
Get the number of files this file is based on.

Throws:
Exception

isJoinLogicalFile

boolean isJoinLogicalFile()
                          throws Exception
Check whether this record format is a join logical file

Throws:
Exception

isSourceFile

boolean isSourceFile()
                     throws Exception
Check whether this record format is source file. If the file is not a source file then it must be a data file.

Throws:
Exception

getLangId

String getLangId()
                 throws Exception
Get the language identifier

Throws:
Exception

getBasedOnFiles

List getBasedOnFiles()
                     throws Exception
Return a list of the based on files

Throws:
Exception

setIGCField

void setIGCField(boolean igcField)
Set whether this record format contains DBCS or Graphic data.


setIGCLiteral

void setIGCLiteral(boolean igcLiteral)
Set whether this record format contains DBCS or Graphic literals.


setAlternateSequence

void setAlternateSequence(boolean altSeq)
Set whether this record format uses an alternate collating sequence (ALTSEQ)


setKeyedAccessPath

void setKeyedAccessPath(boolean keyed)
Set whether this record format has a keyed sequence access path.


setSelectOmitLF

void setSelectOmitLF(boolean selectOmitLF)
Set whether this file is a select/omit logical file.


setDynamicSelect

void setDynamicSelect(boolean dynamicSelect)
Set whether this record format uses the dynamic selection indicator (DYNSLT).


setAccessPathType

void setAccessPathType(String accessPathType)
Set the access path type for this record format.


setBasedOnCount

void setBasedOnCount(int count)
Set the number of files this file is based on.


setJoinLogicalFile

void setJoinLogicalFile(boolean logicalJoinFile)
Set whether this record format is a join logical file


setIsSourceFile

void setIsSourceFile(boolean sourceFile)
Set whether this record format is source file or a data file.


setLangId

void setLangId(String langId)
Set the language identifier


addBasedOnFile

void addBasedOnFile(String library,
                    String file,
                    String record)
Add a based on file to the list of based on files for this logical file.


Rational Developer for Power Systems Software
V7.6

Copyright 2011 IBM Corp. All Rights Reserved.

Note: This documentation is for part of an interim API that is still under development and expected to change significantly before reaching stability. It is being made available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.