iSeries Remote Systems
v6.0.0

com.ibm.etools.iseries.core.api
Class ISeriesFile

java.lang.Object
  extended bycom.ibm.etools.iseries.core.api.ISeriesDataElementWrapper
      extended bycom.ibm.etools.iseries.core.api.ISeriesHostObjectBriefWrapper
          extended bycom.ibm.etools.iseries.core.api.ISeriesHostObjectBasicWrapper
              extended bycom.ibm.etools.iseries.core.api.ISeriesHostObjectExhaustiveWrapper
                  extended bycom.ibm.etools.iseries.core.api.ISeriesObject
                      extended bycom.ibm.etools.iseries.core.api.ISeriesFile
All Implemented Interfaces:
IAdaptable, IISeriesDataElementWrapper, com.ibm.etools.iseries.comm.interfaces.IISeriesFile, com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic, com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief, com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive, com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly, ISeriesDataStoreConstants
Direct Known Subclasses:
ISeriesDisplayFile

public class ISeriesFile
extends ISeriesObject
implements IAdaptable, ISeriesDataStoreConstants, com.ibm.etools.iseries.comm.interfaces.IISeriesFile

This is a usable representation of a src/data/logical file object on a remote iSeries object. It contains most of the attributes as retrieved from the system api for listing objects. It is a specialization of ISeriesObject

This object is instantiated from the DataElement object that is normally returned from a remote list request.

Note that the setXXX methods do not change the file on the host. Rather, their purpose is simply to capture the attribute internally, after reading it from an external source, say.

See the iSeries CL API QUSLOBJ for a full description of each attribute


Field Summary
protected  String _accessPathType
           
protected  boolean _alternateSequence
           
protected  int _basedOnCount
           
protected  String _basedOnFiles
           
protected  boolean _dynamicSelect
           
protected  boolean _igcField
           
protected  boolean _igcLiteral
           
protected  boolean _jfile
           
protected  boolean _keyedAccessPath
           
protected  boolean _selectOmit
           
static String copyright
           
protected  int iCcsid
           
protected  int iRecordLength
           
protected  boolean isDBCS
           
protected  boolean isSrcFile
           
 
Fields inherited from class com.ibm.etools.iseries.core.api.ISeriesObject
bBasicPropertiesAvailable, bExhaustivePropertiesAvailable, bValue, calendar, cValue, date, day, deProperties, deProperty, hour, iValue, lValue, minute, month, sbValue, second, sValue, year
 
Fields inherited from class com.ibm.etools.iseries.core.api.ISeriesDataElementWrapper
cacheFilter, cacheTimeStamp, dataelement, EXPIRE_TIME, lastException, lastRunMsg, lastRunMsgId, localCache
 
Fields inherited from interface com.ibm.etools.iseries.core.dstore.common.ISeriesDataStoreConstants
ABSTRACT_FILTER_DESCRIPTOR, ABSTRACT_NATIVE_FSO_DESCRIPTOR, API_ERROR, API_ERROR_DESCRIPTOR, API_OK, API_PTF_MISSING, API_RESULT_DESCRIPTOR, API_RETURN_CODE, AUTHORITY_LIST_NODE, AUTHORITY_NODE, BATCHCOMMAND_DESCRIPTOR, C_GET_EDIT_CCSID, C_LDA_READ, C_LDA_WRITE, C_USER_PREFERENCES_DIRECTORY, CCSID_DESCRIPTOR, CDRA_INFO, CHECK_AUTHORITY_COMMAND, CLEAR_LOCAL_CACHE, CMD_DEBUG_RELEASE_APPLICATION, CMD_DEBUG_SPAWN_AND_HOLD, CMD_GET_DEBUG_ROUTER_PORT, CMD_IJOB_ASSOCIATE, CMD_IJOB_RELEASE, CMD_IJOB_RUNPGM, CMD_MULTI_SPAWNFAIL, CMD_MULTI_SPAWNSUCC, CMD_RUNBATCHCOMMAND, CMD_RUNBATCHCOMMAND_NOHELP, CMD_RUNCOMMAND, CMD_RUNCOMMAND_MULTITHREADED, CMD_RUNCOMMAND_MULTITHREADED_NOHELP, CMD_RUNCOMMAND_NOHELP, COMM_SERVER_INFORMATION, COMMAND_DESCRIPTOR, COMMAND_FILTER_DESCRIPTOR, COMMAND_MINER, COMMAND_MINER_ROOT_ELEMENT, COMMAND_QUERY_DB_FIELDS, COMMAND_QUERY_DB_KEYS, COMMAND_QUERY_DSPF_ALL, COMMAND_QUERY_MODULE_LIST, COMMAND_QUERY_PROCEDURE_LIST, CREATE_EDIT_MASK, CURRENT_WORKING_DIR, CURRENT_WORKING_DIR_DESCRIPTOR, DBFIELD_ALIAS, DBFIELD_ALLOC_LENGTH, DBFIELD_ALWNUL, DBFIELD_CCSID_SPECIFIED, DBFIELD_COLHEAD1, DBFIELD_COLHEAD2, DBFIELD_COLHEAD3, DBFIELD_DATA_CCSID, DBFIELD_DATTIMFMT, DBFIELD_DATTIMSEP, DBFIELD_DBCS_ALTTYPE, DBFIELD_DBCS_COLHEAD, DBFIELD_DBCS_TEXTDESC, DBFIELD_DBCS_VALCHECK, DBFIELD_DECPOS, DBFIELD_DESCRIPTION, DBFIELD_DIGITS, DBFIELD_DISPLAY_LEN_FLAG, DBFIELD_DISPLAY_LENGTH, DBFIELD_DTFLAGS, DBFIELD_EDITCODE, DBFIELD_EDITCODE_SYMBOL, DBFIELD_EDITWORD, DBFIELD_ENCODING_SCHEME, DBFIELD_GENERIC_KEY_COUNT, DBFIELD_INBUF, DBFIELD_INTNAME, DBFIELD_KEYFIELD_ATTRS, DBFIELD_LENGTH, DBFIELD_MAXKEYLEN, DBFIELD_MIN_DISPLAY_LEN_FLAG, DBFIELD_NUMDBCS, DBFIELD_OPERATOR, DBFIELD_OUTBUF, DBFIELD_REF_FIELD, DBFIELD_REFSHIFT, DBFIELD_SST_END, DBFIELD_SST_START, DBFIELD_TYPE, DBFIELD_UCS2_CONVERT_FLAG, DBFIELD_USAGE, DBFIELD_VARLENGTH, DEBUG_HELD_JOB_DESCRIPTOR, DOWNLOAD_RESULT_AS400_SECURITY_EXCEPTION, DSPFFD_INBUF, DSPFFD_OUTBUF, EDCODE_CURSYM, EDCODE_DATESEP, EDCODE_DECSEP, EDCODE_JOBDESC, EDCODE_JOBDESCLIB, EDCODE_SYSDATE, EDCODE_TIMESEP, EDCODE_USERID, EDIT_CODE_DESCRIPTOR, EDIT_CODE_INFORMATION, EDIT_CODE_QUERY, EDIT_DESCRIPTION, EDIT_MASK_DESCRIPTOR, EDIT_MASK_INFO, EDTD_DECCHAR, EDTD_FILLCHAR, EDTD_FLOATSTR, EDTD_FRACTION_MASK, EDTD_INTMASK, EDTD_LEFTCHAR, EDTD_NEGCHAR, EDTD_POSCHAR, EDTD_RIGHTCHAR, EDTD_ZEROVAL, EDTM_RECLEN, ENVVAR_DESCRIPTOR, ENVVAR_INFO, ERROR_DESCRIPTOR, EVENTSFILE_DESCRIPTOR, FIELD_DESCRIPTOR, FIELD_LIST_NODE, FIELD_PROPERTIES_NODE, FILE_ACCPATHTYPE, FILE_ALTSEQ, FILE_BASEDONCOUNT, FILE_BASEDONFILES, FILE_DESCRIPTOR, FILE_DYNSEL, FILE_IGCFIELD, FILE_IGCLITERAL, FILE_JFILE, FILE_KEYACCESS, FILE_LANGID, FILE_OVERRIDE_INFO, FILE_OVERRIDE_SOURCE_DESCRIPTOR, FILE_OVERRIDE_TARGET_DESCRIPTOR, FILE_PROPERTIES_NODE, FILE_SELECTOMITLF, FILE_SRCFILE, IFS_FILE_FILTER_OBJECT, IFS_FILESYSTEM_MINER, IFS_FILTER_DESCRIPTOR, IFS_FOLDER_FILTER_OBJECT, IJOB_DATAQ_DESCRIPTOR, ISERIES_PROGRAM_DESCRIPTOR, JOB_DESCRIPTOR, JOB_FILTER_DESCRIPTOR, JOB_MINER, JOB_MINER_LOG_ELEMENT, JOB_MINER_ROOT_ELEMENT, JOB_PROPERTY_DESCRIPTOR, JOB_PROPERTY1_ELEMENT, JOB_PROPERTY2_ELEMENT, JOB_PROPERTY3_ELEMENT, JOB_PROPERTYINT_ELEMENT, JOBCMD_CHGJOB, JOBCMD_DSPJOBLOG, JOBCMD_ENDJOB, JOBCMD_ENDJOB_IMMED, JOBCMD_HOLDJOB, JOBCMD_QRYJOB_ALL_PROPERTIES, JOBCMD_QRYJOB_PROPERTY, JOBCMD_QRYJOB_PROPERTYP2, JOBCMD_QRYJOB_PROPERTYP3, JOBCMD_QRYJOB_PROPERTYPINT, JOBCMD_RELEASEJOB, JOBFILTERCMD_QUERY, JOBNAME_DESCRIPTOR, JOBPROP_ACCTCODE, JOBPROP_ACTIVESTATUS, JOBPROP_AUXIO, JOBPROP_BREAKMSGHDL, JOBPROP_CCSID, JOBPROP_CNTRYID, JOBPROP_CTLDENDREQ, JOBPROP_CURRSYSPOOL, JOBPROP_CURRUSER, JOBPROP_DATE_ENTERED, JOBPROP_DATE_STARTED, JOBPROP_DATEFMT, JOBPROP_DATESEP, JOBPROP_DBCSCAP, JOBPROP_DECFMT, JOBPROP_DESCRIPTION, JOBPROP_DEVRCYACT, JOBPROP_DFTCCSID, JOBPROP_ENDSEV, JOBPROP_INQMSGRPLY, JOBPROP_ITRANS, JOBPROP_KEEPDDMACT, JOBPROP_LANGID, JOBPROP_LOGCLP, JOBPROP_LOGLVL, JOBPROP_LOGSEV, JOBPROP_LOGTXT, JOBPROP_MAXCPU, JOBPROP_MAXTMPSTOR, JOBPROP_MSGQACT, JOBPROP_MSGQMAX, JOBPROP_OUTQ, JOBPROP_OUTQ_PTY, JOBPROP_PGMRC, JOBPROP_PRODRC, JOBPROP_PRTDEV, JOBPROP_PRTKEYFMT, JOBPROP_PRTTXT, JOBPROP_PURGE, JOBPROP_ROUTING, JOBPROP_RUNPTY, JOBPROP_SORTTAB, JOBPROP_SPECENV, JOBPROP_STATUSMSGHDL, JOBPROP_SUBMITNAME, JOBPROP_SUBMITNUMBER, JOBPROP_SUBMITUSER, JOBPROP_SUBSYSTEM, JOBPROP_SUBTYPE, JOBPROP_SWITCHES, JOBPROP_SYSPOOL, JOBPROP_THREADS, JOBPROP_TIMESEP, JOBPROP_TIMESLICE, JOBPROP_TIMESLICEPOOL, JOBPROP_TOTRESPTIME, JOBPROP_TYPE, JOBPROP_USEDCPU, JOBPROP_USEDTMPSTOR, JOBPROP_USERRC, JOBPROP_WAITTIME, KEYFIELD_LIST_NODE, KEYWORD_DESCRIPTOR, LDA_READ_EXCEPTION_DESCRIPTOR, LDA_READ_LIBRARY_NAME_DESCRIPTOR, LDA_READ_MEMBER_NAME_DESCRIPTOR, LDA_READ_NO_OUTPUT_DESCRIPTOR, LDA_WRITE_CCSID_DESCRIPTOR, LDA_WRITE_EXCEPTION_DESCRIPTOR, LDA_WRITE_LENGTH_DESCRIPTOR, LIB_FILTER_DESCRIPTOR, LIB_FILTER_STR_DESCRIPTOR, LIBRARY_DESCRIPTOR, LIBRARY_PROPERTIES_NODE, LIST_OBJ_LOCKS_COMMAND, MBR_FILTER_DESCRIPTOR, MBR_FILTER_STR_DESCRIPTOR, MEMBER_CHANGE_TIMESTAMP, MEMBER_CREATION_TIMESTAMP, MEMBER_DESCRIPTOR, MEMBER_NUMBER_OF_DELETED, MEMBER_NUMBER_OF_RECORDS, MEMBER_PROPERTIES_NODE, MEMBER_RESTOTE_TIMESTAMP, MEMBER_SAVE_TIMESTAMP, MESSAGE_DESCRIPTOR, MESSAGE_FILE_DESCRIPTOR, MESSAGED_DESCRIPTOR, MODULE_DESCRIPTOR, MODULE_INTERNAL_DESCRIPTOR, MODULE_LANGID, MODULE_LIST_NODE, MODULE_PROPERTIES_NODE, MSGD_STRUCTURE_NODE, NATIVE_FILESYSTEM_MINER, NETINT_DESCRIPTOR, NETINT_LIST_NODE, NETINT_QUERY, NETWORK_ERROR_DESCRIPTOR, OBJ_FILTER_DESCRIPTOR, OBJ_FILTER_STR_DESCRIPTOR, OBJECT_DESCRIPTOR, OBJECT_PROPERTIES_NODE, PGM_DEBUGGABLE, PGM_OPM, PROCEDURE_DESCRIPTOR, PROCEDURE_LIST_NODE, PROGRAM_DESCRIPTOR, PROPERTY_DESCRIPTOR, QSYS_DESCRIPTOR, QUERY_CURRENT_WORKING_DIR, QUERY_DEVICE_RECORDS, QUERY_ENCODING_SCHEME, QUERY_ENV_VAR, QUERY_FIELD_LIST, QUERY_FILE_PROPERTIES, QUERY_MEMBER_PROPERTIES, QUERY_MESSAGE_DESCRIPTORS_COMMAND, QUERY_RECORD_LIST, QUERY_RECORD_PROPERTIES, RECORD_BUFFER_SIZE, RECORD_CCSID, RECORD_DESC, RECORD_DESCRIPTOR, RECORD_DEVICE_PROPERTIES, RECORD_FLDCNT, RECORD_HAS_SEP_IND_AREA, RECORD_HAS_START_LINE_NUM, RECORD_ISDBCS, RECORD_LEVELID, RECORD_LIST_NODE, RECORD_LOWEST_RESP_IND, RECORD_PROPERTIES_NODE, RECORD_RECLEN, RECORD_STANDARD_PROPERTIES, RECORD_TYPE, RELATIVE_FILTER_DESCRIPTOR, RESULT_MESSAGES_ELEMENT, RETRIEVE_FILE_OVERRIDE_COMMAND, SERVICE_PROGRAM_DESCRIPTOR, SORT_SEQ_TABLE, SORT_SEQ_TABLE_INFO, SPECIAL_FILTER_DESCRIPTOR, SQL_COLERROR, SQL_COLFIRSTBYTE, SQL_COLLASTBYTE, SQL_DESCRIPTOR, SQL_MSGFILE, SQL_MSGID, SQL_MSGLIB, SQL_MSGREPLACELEN, SQL_MSGREPLACETEXT, SQL_NUMSTMT, SQL_RECERORR, SQL_RECFIRSTBYTE, SQL_RECLASTBYTE, SQL_RETINFOLEN, SQL_STATE, SQL_SYNTAX_CHECK, SQL_SYNTAX_CHECK_INFO, SST_BYTESAVAIL, SST_BYTESRETURN, SST_COUNTRYID, SST_JOBCCSID, SST_LANGID, SST_QUERY, SST_SSTLIB, SST_SSTNAME, SST_SUBSITUTION, SST_TABLE, SST_TABLECCSID, SST_TABLELIB, SST_TABLENAME, SST_WEIGHT, STRUCTURE_NODE_DESCRIPTOR, SYSTEM_INFORMATION, SYSTEM_PROPERTY_DESCRIPTOR, SYSTEM_QIGC, SYSTEM_VRM, TABLE_DESCRIPTOR
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectExhaustive
AUDITING_ALL, AUDITING_CHANGE, AUDITING_NONE, AUDITING_USRPRF, COMPRESSION_COMPRESSED, COMPRESSION_NOTCOMPRESSABLE, COMPRESSION_NOTCOMPRESSED, COMPRESSION_SAVEDFREED, COMPRESSION_TEMPORARILYCOMPRESSED, Copyright, DOMAIN_SYSTEM, DOMAIN_USER, STORAGE_FREE, STORAGE_KEEP
 
Fields inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
STATUS_DAMAGED, STATUS_LOCKED, STATUS_NOTAUTHORIZED, STATUS_OK, STATUS_PARTIALLYDAMAGED, STATUS_STRING_DAMAGED, STATUS_STRING_LOCKED, STATUS_STRING_NOTAUTHORIZED, STATUS_STRING_PARTIALLYDAMAGED
 
Constructor Summary
ISeriesFile(com.ibm.etools.systems.dstore.core.model.DataElement dataelement, boolean sourceFile)
          Constructor
 
Method Summary
 ISeriesMember createSourceMember(Shell shell, String mbrName, String mbrType, String mbrText)
          Create a source member in this file, given a member name and source type, and optionally descriptive text
 boolean exists()
          Queries whether the file exists
 String getAccessPathType()
          Returns the accessPathType for this file.
 int getBasedOnCount()
          Returns the number of files this file is based on.
 String getBasedOnFiles()
          Returns the files this file is based on.
 int getCcsid()
          Return the ccsid value for this file
 String getEncoding()
          Get the encoding of the file represented by its CCSID
 String getFileSubType()
           
 String getLangId()
           
 ISeriesRecord getRecord(Shell shell)
          Retrieve the record format for this file.
 ISeriesRecord getRecord(Shell shell, String recordName)
          Return the record format this file.
 com.ibm.etools.iseries.comm.interfaces.IISeriesRecord getRecord(String recordName)
          Return the record format from this file.
 int getRecordLength()
          Return the record length of this file
 boolean isAlternateSequence()
          Returns whether this file has an alternate sequence table specified.
 boolean isDBCS()
          Returns whether the file is a DBCS file or not
 boolean isDynamicSelect()
          Check if the selection and omission tests specified for the file are done when the file is read or when the access path is updated.
 boolean isIgcField()
          Check if the file's record format(s) contain DBCS or graphic fields.
 boolean isIgcLiteral()
          Check if the file's record format(s) contain DBCS or graphic literals.
 boolean isJoinLogicalFile()
          Check if this is a join logical file.
 boolean isKeyedAccessPath()
          Check if the file has a keyed sequence access path or an arrival sequence access path.
 boolean isSelectOmit()
          Returns the selectOmit.
 boolean isSourceFile()
          Return true if this is a source file
 ISeriesDatabaseField[] listFields(Shell shell)
          Deprecated. Use listRecords() first and then use the listFields() method on the record.
 ISeriesDatabaseField[] listFields(Shell shell, String recordName, String fieldName)
          Deprecated. Use listRecords() first and then use the listFields() method on the record.
static String[] listMemberNames(Shell shell, ISeriesConnection connection, String library, String file, String nameFilter, String[] typeFilters)
          This is a high performance way to query the members names only in a given file, optionally subset by member name and type.
 String[] listMemberNames(Shell shell, String nameFilter, String[] typeFilters)
          This is a high performance way to query the members names only in this file, optionally subset by member name and type.
 ISeriesMember[] listMembers(Shell shell)
          Return a list of all members
 ISeriesMember[] listMembers(Shell shell, String nameFilter)
          Return a list of members subsetted by the member name
 ISeriesMember[] listMembers(Shell shell, String[] mbrTypes)
          Return a list of members, subset by member type(s)
 ISeriesMember[] listMembers(Shell shell, String nameFilter, String[] mbrTypes)
          Return a list of members subsetted by member name and type
static String[] listRecordNames(Shell shell, ISeriesConnection connection, String library, String file, String nameFilter)
          This is a high performance way to query the record names only in a given file, optionally subset by record name.
 String[] listRecordNames(Shell shell, String nameFilter)
          This is a high performance way to query the record names only in this file.
 com.ibm.etools.iseries.comm.interfaces.IISeriesRecord[] listRecords()
          Return a list of all records for this file
 ISeriesRecord[] listRecords(Shell shell)
          Return a list of all records for this file
 ISeriesRecord[] listRecords(Shell shell, String filterName)
          Return a list of records for this file object that match the filterName
 void showFieldsInTable(Shell shell)
          Instance method to easily show the fields table for this file.
static void showFieldsInTable(Shell shell, ISeriesConnection conn400, String libName, String fileName)
          Static method to easily show the fields table, given the minimum information needed.
 void showMembersInTable(Shell shell)
          Instance method to easily show the members table for this file.
static void showMembersInTable(Shell shell, ISeriesConnection conn400, String libName, String fileName)
          Static method to easily show the members table, given the minimum information needed.
 
Methods inherited from class com.ibm.etools.iseries.core.api.ISeriesObject
clearCachedProperties, equals, getAbsoluteName, getAdapter, getAllowChangeByProgram, getAPAR, getAttribute, getAuxiliaryStoragePool, getBasicProperties, getChangedByProgram, getCompiler, getCompressionStatus, getCreatorUserProfile, getDateCreated, getDateModified, getDaysUsedCount, getDescription, getDomain, getFile, getFullName, getInformationStatus, getISeriesLibrary, getLastUsedDate, getLibrary, getLibraryName, getLicensedProgram, getName, getObjectAuditingValue, getObjectLevel, getObjectOverflowedASP, getOwner, getPrimaryGroup, getPTF, getResetDate, getRestoredDate, getSaveActiveDate, getSaveCommand, getSavedDate, getSaveDevice, getSaveFileName, getSaveLabel, getSaveLibrary, getSaveSequenceNumber, getSaveSize, getSaveVolumeId, getSize, getSourceChangedDate, getSourceFile, getSourceLibrary, getSourceMember, getStorage, getSubType, getSystemLevel, getSystemWhereCreated, getType, getUsageInformationUpdated, getUserChanged, getUserDefinedAttribute, setAllowChangeByProgram, setAPAR, setAuxiliaryStoragePool, setChangedByProgram, setCompiler, setCompressionStatus, setCreatorUserProfile, setDateCreated, setDateModified, setDaysUsedCount, setDescription, setDomain, setFile, setInformationStatus, setISeriesLibrary, setLastUsedDate, setLibrary, setLicensedProgram, setName, setObjectAuditingValue, setObjectLevel, setObjectOverflowedASP, setOwner, setPrimaryGroup, setPTF, setResetDate, setRestoredDate, setSaveActiveDate, setSaveCommand, setSavedDate, setSaveDevice, setSaveFileName, setSaveLabel, setSaveLibrary, setSaveSequenceNumber, setSaveSize, setSaveVolumeId, setSize, setSourceChangedDate, setSourceFile, setSourceLibrary, setSourceMember, setStorage, setSubType, setSystemLevel, setSystemWhereCreated, setType, setUsageInformationUpdated, setUserChanged, setUserDefinedAttribute, toString, writeObjectInfo
 
Methods inherited from class com.ibm.etools.iseries.core.api.ISeriesDataElementWrapper
checkIsConnected, extractProperty, extractPropertyAsBoolean, extractPropertyAsByte, extractPropertyAsChar, extractPropertyAsInt, getCommandSubSystem, getDataElement, getDataStore, getFileSubSystem, getISeriesConnection, getLastException, getLastRunMessage, getLocalCache, getPropertiesNode, runCommand, setLastException, setLocalCache
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile
getLibraryName
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBasic
getDateCreated, getDateModified, getSize, setDateCreated, setDateModified, setSize
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectBrief
getDescription, getFile, getInformationStatus, getSubType, getType, setDescription, setFile, setInformationStatus, setSubType, setType
 
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly
getLibrary, getName, setLibrary, setName, toString
 

Field Detail

copyright

public static final String copyright
See Also:
Constant Field Values

isSrcFile

protected boolean isSrcFile

isDBCS

protected boolean isDBCS

iCcsid

protected int iCcsid

iRecordLength

protected int iRecordLength

_igcField

protected boolean _igcField

_igcLiteral

protected boolean _igcLiteral

_alternateSequence

protected boolean _alternateSequence

_keyedAccessPath

protected boolean _keyedAccessPath

_jfile

protected boolean _jfile

_selectOmit

protected boolean _selectOmit

_dynamicSelect

protected boolean _dynamicSelect

_accessPathType

protected String _accessPathType

_basedOnCount

protected int _basedOnCount

_basedOnFiles

protected String _basedOnFiles
Constructor Detail

ISeriesFile

public ISeriesFile(com.ibm.etools.systems.dstore.core.model.DataElement dataelement,
                   boolean sourceFile)
Constructor

Method Detail

isSourceFile

public boolean isSourceFile()
Return true if this is a source file

Specified by:
isSourceFile in interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile

listMembers

public ISeriesMember[] listMembers(Shell shell)
                            throws com.ibm.etools.systems.core.messages.SystemMessageException
Return a list of all members

Parameters:
shell - A shell that can be used to create the Signon prompt dialog if required, if null is passed then the workbench will be searched for a shell to use for the Signon prompt
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listMembers

public ISeriesMember[] listMembers(Shell shell,
                                   String[] mbrTypes)
                            throws com.ibm.etools.systems.core.messages.SystemMessageException
Return a list of members, subset by member type(s)

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listMembers

public ISeriesMember[] listMembers(Shell shell,
                                   String nameFilter)
                            throws com.ibm.etools.systems.core.messages.SystemMessageException
Return a list of members subsetted by the member name

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listMembers

public ISeriesMember[] listMembers(Shell shell,
                                   String nameFilter,
                                   String[] mbrTypes)
                            throws com.ibm.etools.systems.core.messages.SystemMessageException
Return a list of members subsetted by member name and type

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listRecords

public com.ibm.etools.iseries.comm.interfaces.IISeriesRecord[] listRecords()
                                                                    throws Exception
Return a list of all records for this file

Specified by:
listRecords in interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile
Throws:
Exception

listRecords

public ISeriesRecord[] listRecords(Shell shell,
                                   String filterName)
                            throws com.ibm.etools.systems.core.messages.SystemMessageException
Return a list of records for this file object that match the filterName

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listRecords

public ISeriesRecord[] listRecords(Shell shell)
                            throws com.ibm.etools.systems.core.messages.SystemMessageException
Return a list of all records for this file

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listRecordNames

public String[] listRecordNames(Shell shell,
                                String nameFilter)
                         throws com.ibm.etools.systems.core.messages.SystemMessageException
This is a high performance way to query the record names only in this file. This does not query all the properties usually returned for each record so is very efficient.

Parameters:
shell - The hosting dialog
nameFilter - A generic name pattern for the records. Can be null for all record names.
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listRecordNames

public static String[] listRecordNames(Shell shell,
                                       ISeriesConnection connection,
                                       String library,
                                       String file,
                                       String nameFilter)
                                throws com.ibm.etools.systems.core.messages.SystemMessageException
This is a high performance way to query the record names only in a given file, optionally subset by record name. This does not query all the properties usually returned for each record so is very efficient.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listMemberNames

public String[] listMemberNames(Shell shell,
                                String nameFilter,
                                String[] typeFilters)
                         throws com.ibm.etools.systems.core.messages.SystemMessageException
This is a high performance way to query the members names only in this file, optionally subset by member name and type. This does not query all the properties usually returned for each member so is very efficient. It can be used to populate a ValidatorISeriesMember object, for example, to validate member names are unique.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listMemberNames

public static String[] listMemberNames(Shell shell,
                                       ISeriesConnection connection,
                                       String library,
                                       String file,
                                       String nameFilter,
                                       String[] typeFilters)
                                throws com.ibm.etools.systems.core.messages.SystemMessageException
This is a high performance way to query the members names only in a given file, optionally subset by member name and type. This does not query all the properties usually returned for each member so is very efficient. It can be used to populate a ValidatorISeriesMember object, for example, to validate member names are unique.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getRecord

public ISeriesRecord getRecord(Shell shell)
                        throws com.ibm.etools.systems.core.messages.SystemMessageException
Retrieve the record format for this file. The first record format is retrieved.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getRecord

public ISeriesRecord getRecord(Shell shell,
                               String recordName)
                        throws com.ibm.etools.systems.core.messages.SystemMessageException
Return the record format this file.

Parameters:
recordName - The name of the record to retrieve.
Returns:
IISeriesHostFormatDefinition The record format definition
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getRecord

public com.ibm.etools.iseries.comm.interfaces.IISeriesRecord getRecord(String recordName)
                                                                throws Exception
Return the record format from this file.

Specified by:
getRecord in interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile
Parameters:
recordName - The name of the record to retrieve.
Returns:
IISeriesHostFormatDefinition The record format definition
Throws:
Exception

listFields

public ISeriesDatabaseField[] listFields(Shell shell)
                                  throws com.ibm.etools.systems.core.messages.SystemMessageException
Deprecated. Use listRecords() first and then use the listFields() method on the record.

List the fields for this database file. The first record is used if the database file has more than one record.

Returns:
An instance of ISeriesField for each field in the database file.
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

listFields

public ISeriesDatabaseField[] listFields(Shell shell,
                                         String recordName,
                                         String fieldName)
                                  throws com.ibm.etools.systems.core.messages.SystemMessageException
Deprecated. Use listRecords() first and then use the listFields() method on the record.

List the fields for this database file. The first record is used if the database file has more than one record.

Parameters:
recordName - The name of the record for this database for which the field information is to be returned.
fieldName - The name of the field(s) to retrieve. This can be a generic name such as A*
Returns:
An instance of ISeriesField for each field in the database file.
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getCcsid

public int getCcsid()
             throws com.ibm.etools.systems.core.messages.SystemMessageException
Return the ccsid value for this file

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getRecordLength

public int getRecordLength()
                    throws com.ibm.etools.systems.core.messages.SystemMessageException
Return the record length of this file

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getEncoding

public String getEncoding()
                   throws Exception
Get the encoding of the file represented by its CCSID

Returns:
the encoding
Throws:
Exception

isDBCS

public boolean isDBCS()
               throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns whether the file is a DBCS file or not

Returns:
true if file is DBCS, false otherwise
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

exists

public boolean exists()
               throws com.ibm.etools.systems.core.messages.SystemMessageException
Queries whether the file exists

Returns:
true if member exists on the server, false otherwise
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

createSourceMember

public ISeriesMember createSourceMember(Shell shell,
                                        String mbrName,
                                        String mbrType,
                                        String mbrText)
                                 throws com.ibm.etools.systems.core.messages.SystemMessageException
Create a source member in this file, given a member name and source type, and optionally descriptive text

Returns:
the ISeriesMember representing the new member, or null if it failed to create for some reason
Throws:
a - SystemMessageException wrapping a SystemMessage wrapping the host error message the resulted when attempting to create the member
com.ibm.etools.systems.core.messages.SystemMessageException

showMembersInTable

public void showMembersInTable(Shell shell)
                        throws com.ibm.etools.systems.core.messages.SystemMessageException
Instance method to easily show the members table for this file.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

showFieldsInTable

public void showFieldsInTable(Shell shell)
                       throws com.ibm.etools.systems.core.messages.SystemMessageException
Instance method to easily show the fields table for this file.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

showMembersInTable

public static void showMembersInTable(Shell shell,
                                      ISeriesConnection conn400,
                                      String libName,
                                      String fileName)
                               throws com.ibm.etools.systems.core.messages.SystemMessageException
Static method to easily show the members table, given the minimum information needed.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

showFieldsInTable

public static void showFieldsInTable(Shell shell,
                                     ISeriesConnection conn400,
                                     String libName,
                                     String fileName)
                              throws com.ibm.etools.systems.core.messages.SystemMessageException
Static method to easily show the fields table, given the minimum information needed.

Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getAccessPathType

public String getAccessPathType()
                         throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the accessPathType for this file.

Returns:
String
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

isAlternateSequence

public boolean isAlternateSequence()
                            throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns whether this file has an alternate sequence table specified.

Returns:
boolean
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getBasedOnCount

public int getBasedOnCount()
                    throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the number of files this file is based on. This property is only applicable to logical files.

Returns:
int
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getBasedOnFiles

public String getBasedOnFiles()
                       throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the files this file is based on. This String has the format "LIB1/FIL1/REC1;LIB2/FIL2/REC2; ... LIBN/FILN/RECN;"

Returns:
String the based on files as a long String
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

isDynamicSelect

public boolean isDynamicSelect()
                        throws com.ibm.etools.systems.core.messages.SystemMessageException
Check if the selection and omission tests specified for the file are done when the file is read or when the access path is updated.

Returns:
boolean true if selection and omission test are done when the file is read, false if they are done when the access path is updated.
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

isIgcField

public boolean isIgcField()
                   throws com.ibm.etools.systems.core.messages.SystemMessageException
Check if the file's record format(s) contain DBCS or graphic fields.

Returns:
boolean
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

isIgcLiteral

public boolean isIgcLiteral()
                     throws com.ibm.etools.systems.core.messages.SystemMessageException
Check if the file's record format(s) contain DBCS or graphic literals.

Returns:
boolean
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

isKeyedAccessPath

public boolean isKeyedAccessPath()
                          throws com.ibm.etools.systems.core.messages.SystemMessageException
Check if the file has a keyed sequence access path or an arrival sequence access path.

Returns:
boolean true if the file has a keyed sequence access path, false if it has an arrival sequence access path.
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

isSelectOmit

public boolean isSelectOmit()
                     throws com.ibm.etools.systems.core.messages.SystemMessageException
Returns the selectOmit.

Returns:
boolean
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

isJoinLogicalFile

public boolean isJoinLogicalFile()
                          throws com.ibm.etools.systems.core.messages.SystemMessageException
Check if this is a join logical file.

Returns:
int
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getLangId

public String getLangId()
                 throws com.ibm.etools.systems.core.messages.SystemMessageException
Throws:
com.ibm.etools.systems.core.messages.SystemMessageException

getFileSubType

public String getFileSubType()
Specified by:
getFileSubType in interface com.ibm.etools.iseries.comm.interfaces.IISeriesFile

iSeries Remote Systems
v6.0.0

Copyright © 2005 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.