|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.etools.iseries.core.api.ISeriesDataElementWrapper
com.ibm.etools.iseries.core.api.ISeriesHostRecordNameOnlyWrapper
com.ibm.etools.iseries.core.api.ISeriesHostRecordBasicWrapper
com.ibm.etools.iseries.core.api.ISeriesRecord
Represents a database or device record. It contains all the attributes available for records via the iSeries list-fields api. This base class contains the maximum attributes that are common between database and device records. There are more attributes that are unique to device records. For these, use ISeriesRecordDevice.
Note that the setXXX methods do not change the record 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 QUSLRCD for a full description of each attribute
Field Summary | |
---|---|
static String |
copyright
|
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.comm.interfaces.IISeriesHostRecordBasic |
---|
Copyright |
Constructor Summary | |
---|---|
ISeriesRecord(com.ibm.etools.systems.dstore.core.model.DataElement dataelement)
Constructor when using DataStore DataElements |
|
ISeriesRecord(com.ibm.etools.systems.dstore.core.model.DataElement dataelement,
boolean databaseFieldsRetrieved)
Constructor when using DataStore DataElements |
|
ISeriesRecord(com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic rcdObj)
Constructor when wrapping an IISeriesHostRecordBasic interface conforming object |
Method Summary | |
---|---|
String |
getDescription()
Get the record's description |
int |
getFieldCount()
Get the number of fields in the record |
String |
getID()
Get the record's format ID |
ISeriesConnection |
getISeriesConnection()
Returns the ISeriesConnection from which this object originated. |
com.ibm.etools.iseries.comm.interfaces.IISeriesFile |
getISeriesFile()
Return the parent file. |
ISeriesFile |
getISeriesFile(Shell shell)
Return the parent file. |
int |
getLength()
Get the record's length |
protected com.ibm.etools.systems.dstore.core.model.DataElement |
getPropertiesNode()
Retrieve the properties node for this record |
boolean |
hasDBCSorGraphicFields()
Checks if this record has DBCS or Graphic fields |
com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField[] |
listDatabaseFields()
Return a list of fields for this record. |
com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField[] |
listDatabaseFields(Shell shell)
Return a list of fields for this record. |
com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField[] |
listDatabaseFieldsWithFilter(Shell shell,
String fieldName)
Return a list of fields for this record. |
com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField[] |
listDatabaseFieldsWithFilter(String fieldName)
Return a list of fields for this record. |
static String[] |
listFieldNames(Shell shell,
ISeriesConnection connection,
String library,
String file,
String record,
String nameFilter)
This is a high performance way to query the field names only in a given record, optionally subset by field name. |
String[] |
listFieldNames(Shell shell,
String nameFilter)
This is a high performance way to query the field names only in this record. |
ISeriesField[] |
listFields(Shell shell)
Return a list of all fields in this record |
ISeriesField[] |
listFields(Shell shell,
String nameFilter)
Return a list of fields in this record that match the nameFilter |
void |
setDescription(String text)
Set the record's description |
void |
setFieldCount(int nbr)
Set the number of fields in the record |
void |
setID(String text)
Set the record's format ID |
void |
setISeriesFile(ISeriesFile parentFile)
Set the parent ISeriesFile of this object, if we know it. |
void |
setLength(int len)
Set the record's total length |
Methods inherited from class com.ibm.etools.iseries.core.api.ISeriesHostRecordNameOnlyWrapper |
---|
getAbsoluteName, getAdapter, getFile, getFileType, getFullName, getLibrary, getLibraryName, getName, getRecordObject, setFile, setFileType, setLibrary, setName, toString, writeObjectInfo |
Methods inherited from class com.ibm.etools.iseries.core.api.ISeriesDataElementWrapper |
---|
checkIsConnected, extractProperty, extractPropertyAsBoolean, extractPropertyAsByte, extractPropertyAsChar, extractPropertyAsInt, getCommandSubSystem, getDataElement, getDataStore, getFileSubSystem, getLastException, getLastRunMessage, getLocalCache, getPropertiesNode, runCommand, setLastException, setLocalCache |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordNameOnly |
---|
getFile, getFileType, setFile, setFileType, toString, writeObjectInfo |
Methods inherited from interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostObjectNameOnly |
---|
getLibrary, getName, setLibrary, setName |
Field Detail |
public static final String copyright
Constructor Detail |
public ISeriesRecord(com.ibm.etools.systems.dstore.core.model.DataElement dataelement)
public ISeriesRecord(com.ibm.etools.systems.dstore.core.model.DataElement dataelement, boolean databaseFieldsRetrieved)
public ISeriesRecord(com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic rcdObj)
Method Detail |
public ISeriesField[] listFields(Shell shell, String nameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField[] listDatabaseFields() throws Exception
listDatabaseFields
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesRecord
Exception
public com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField[] listDatabaseFieldsWithFilter(String fieldName) throws Exception
listDatabaseFieldsWithFilter
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesRecord
fieldName
- field name (can be generic) for list of fields to retreive
Exception
public com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField[] listDatabaseFields(Shell shell) throws Exception
Exception
public com.ibm.etools.iseries.comm.interfaces.IISeriesHostDatabaseField[] listDatabaseFieldsWithFilter(Shell shell, String fieldName) throws Exception
fieldName
- field name (can be generic) for list of fields to retreive
Exception
public ISeriesField[] listFields(Shell shell) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public String[] listFieldNames(Shell shell, String nameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
shell
- The hosting dialognameFilter
- A generic name pattern for the fields. Can be null for all field names.
com.ibm.etools.systems.core.messages.SystemMessageException
public static String[] listFieldNames(Shell shell, ISeriesConnection connection, String library, String file, String record, String nameFilter) throws com.ibm.etools.systems.core.messages.SystemMessageException
com.ibm.etools.systems.core.messages.SystemMessageException
public com.ibm.etools.iseries.comm.interfaces.IISeriesFile getISeriesFile()
getISeriesFile
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesRecord
public ISeriesFile getISeriesFile(Shell shell)
public void setISeriesFile(ISeriesFile parentFile)
public ISeriesConnection getISeriesConnection()
ISeriesDataElementWrapper
getISeriesConnection
in class ISeriesDataElementWrapper
This is a workaround until we support DataElements for Records and fields
public boolean hasDBCSorGraphicFields()
hasDBCSorGraphicFields
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesRecord
public void setID(String text)
setID
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic
public void setLength(int len)
setLength
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic
public void setFieldCount(int nbr)
setFieldCount
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic
public void setDescription(String text)
setDescription
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic
public String getID()
getID
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic
public int getLength()
getLength
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic
public int getFieldCount()
getFieldCount
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic
public String getDescription()
getDescription
in interface com.ibm.etools.iseries.comm.interfaces.IISeriesHostRecordBasic
protected final com.ibm.etools.systems.dstore.core.model.DataElement getPropertiesNode()
getPropertiesNode
in class ISeriesHostRecordNameOnlyWrapper
|
iSeries Remote Systems v6.0.1 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |