public class CatalogSearch.Entry
extends java.lang.Object
isCatalogEntry()
,
isDatasetEntry()
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getCatalogName()
Return the name of the current Catalog (the entry name of the last
Catalog entry read).
|
int |
getEntryLength()
Return the total length, in bytes, that this entry comprises in the work area.
|
CatalogSearchField |
getField(java.lang.String fieldName)
Return the field data associated with a fieldName.
|
byte |
getFlag()
Return the entry flag byte.
|
java.lang.String |
getModuleId()
Return the entry reason area module id.
|
java.lang.String |
getName()
Return a String containing the 1-44 character name (blanks trimmed)
|
int |
getRc()
Return the entry reason area return code.
|
int |
getReason()
Return the entry reason area reason code.
|
char |
getType()
Return the entry type.
|
boolean |
hasError()
Return true if the entry has an error.
|
boolean |
hasReasonArea() |
boolean |
isCatalogEntry()
Return true if this entry is a Catalog entry.
|
boolean |
isDatasetEntry()
Return true if this entry is a Dataset entry.
|
public boolean isCatalogEntry()
public boolean isDatasetEntry()
public boolean hasError()
getRc()
and getReason()
can be
used to determine what the error is.public int getRc()
hasError()
is false.public int getReason()
hasError()
is false.public java.lang.String getModuleId()
hasError()
is false.public boolean hasReasonArea()
public int getEntryLength()
Each entry has the following common information:
public java.lang.String getCatalogName()
public byte getFlag()
See See FLAG_* constants for possible values and consult the Catalog Search Interface documentation for details.
public char getType()
For catalog entries, this value will be CatalogSearch.CATALOG_TYPE
.
For non-catalog entries, this value will be one of the entry types as
described in CatalogSearch.setEntryTypes(String)
.
public java.lang.String getName()
public CatalogSearchField getField(java.lang.String fieldName)
fieldName
- one of the names added via CatalogSearch.addFieldName(String)
.java.lang.UnsupportedOperationException
- if this method is called on a Catalog EntryisCatalogEntry()