public interface IDfResultEntry
Modifier and Type | Field and Description |
---|---|
static int |
MODIFIED
Result status: the result has been modified.
|
static int |
NEW
Result status: the result is a new one.
|
static int |
OLD
Result status: the result is an old one.
|
Modifier and Type | Method and Description |
---|---|
IDfEnumeration |
enumAttrs()
Returns an enumeration of IDfAttr objects.
|
int |
findAttrIndex(java.lang.String attrName)
Gets the index of a specific attribute in the list of attributes that belong to this object.
|
int |
findBoolean(java.lang.String attrName,
boolean value)
Searches through the values in a repeating attribute and returns the first index value that corresponds to the
specified boolean value.
|
int |
findDouble(java.lang.String attrName,
double value)
Searches through the values in a repeating attribute and returns the first index value that corresponds to the
specified double value.
|
int |
findId(java.lang.String attrName,
IDfId value)
Searches through the values in a repeating attribute and returns the first index value that corresponds to the
specified object id value.
|
int |
findInt(java.lang.String attrName,
int value)
Searches through the values in a repeating attribute and returns the first index value that corresponds to the
specified integer value.
|
int |
findString(java.lang.String attrName,
java.lang.String value)
Searches through the values in a repeating attribute and returns the first index value that corresponds to the
specified string value.
|
int |
findTime(java.lang.String attrName,
IDfTime value)
Searches through the values in a repeating attribute and returns the first index value that corresponds to the
specified time value.
|
int |
findValue(java.lang.String attrName,
IDfValue value)
Searches through the values in a repeating attribute and returns the first index value that corresponds to the
specified value.
|
java.lang.String |
getAllRepeatingStrings(java.lang.String attrName,
java.lang.String separator)
Returns all the values stored in a repeating attribute as a single string.
|
IDfAttr |
getAttr(int attrIndex)
Returns an IDfAttr representing the attribute located at a specific position in this object list of attributes.
|
IDfAttr |
getAttr(java.lang.String attrName)
Gets an attribute definition based on its name.
|
int |
getAttrCount()
Returns the number of attributes belonging to this object.
|
int |
getAttrDataType(java.lang.String attrName)
Returns the data type of an attribute.
|
boolean |
getBoolean(java.lang.String attrName)
Returns the boolean value stored in a specific attribute.
|
double |
getDouble(java.lang.String attrName)
Returns the double value stored in a specific attribute.
|
int |
getGlobalSeqNumber()
Gets the global sequence number of the result, that is to say its arrival order with respect to the query
execution.
|
IDfId |
getId(java.lang.String attrName)
Returns the object ID stored in a specific attribute.
|
int |
getInt(java.lang.String attrName)
Returns the integer value stored in a specific attribute.
|
java.lang.String |
getKey()
Gets a key that is a String representation of this result.
|
long |
getLong(java.lang.String attrName)
Returns the long integer value stored in a specific attribute.
|
IDfEnumeration |
getMatchingTerms()
Gets the result terms matching the query.
|
IDfEnumeration |
getMetadataHighlights()
Gets the result metadata highlight entries matching the query.
|
boolean |
getRepeatingBoolean(java.lang.String attrName,
int valueIndex)
Returns the boolean value stored in a repeating attribute, located at a specific index.
|
double |
getRepeatingDouble(java.lang.String attrName,
int valueIndex)
Returns the double value stored in a repeating attribute, located at a specific index.
|
IDfId |
getRepeatingId(java.lang.String attrName,
int valueIndex)
Returns the object ID value stored in a repeating attribute, located at a specific index.
|
int |
getRepeatingInt(java.lang.String attrName,
int valueIndex)
Returns the integer value stored in a repeating attribute, located at a specific index.
|
long |
getRepeatingLong(java.lang.String attrName,
int valueIndex)
Returns the long value stored in a repeating attribute, located at a specific index.
|
java.lang.String |
getRepeatingString(java.lang.String attrName,
int valueIndex)
Returns the string value stored in a repeating attribute, located at a specific index.
|
IDfTime |
getRepeatingTime(java.lang.String attrName,
int valueIndex)
Returns the time value stored in a repeating attribute, located at a specific index.
|
IDfValue |
getRepeatingValue(java.lang.String attrName,
int valueIndex)
Returns the value stored in a repeating attribute, located at a specific index.
|
double |
getScore()
Gets the relevance score of the results with respect to the query.
|
int |
getSeqNumber()
Gets the sequence number of the result relative to its source.
|
java.lang.String |
getSource()
Gets the internal name of the source this result comes from.
|
int |
getStatus()
Returns the status of the result.
|
java.lang.String |
getString(java.lang.String attrName)
Returns the string value stored in a specific attribute.
|
IDfTime |
getTime(java.lang.String attrName)
Returns the time value stored in a specific attribute.
|
IDfValue |
getValue(java.lang.String attrName)
Returns the value stored in a specific attribute.
|
IDfValue |
getValueAt(int index)
Returns the value stored in the attribute at the specified attribute index.
|
int |
getValueCount(java.lang.String attrName)
Returns the number of values stored in an attribute.
|
boolean |
hasAttr(java.lang.String attrName)
Indicates whether an attribute exists for this object.
|
boolean |
isAttrRepeating(java.lang.String attrName)
Indicates whether the attribute
attrName is a repeating attribute. |
boolean |
isRepositoryObject()
Indicates if the result comes from a repository and can be accessed as a IDfTypedObject.
|
boolean |
isUrlAddressible()
Indicates if the result corresponding content is accessible directly through a URL.
|
static final int OLD
static final int NEW
static final int MODIFIED
IDfAttr getAttr(java.lang.String attrName)
attrName
- The name of the attribute; or null
if the attribute is not found.boolean isUrlAddressible()
true
, if a URL can be used to access content; false
otherwise.boolean isRepositoryObject()
true
, if this object is repository object; false
otherwise.java.lang.String getKey()
IDfResultsSet.getResultByKey(String)
java.lang.String getSource()
double getScore()
int getSeqNumber()
int getGlobalSeqNumber()
IDfEnumeration getMatchingTerms()
IDfEnumeration getMetadataHighlights()
boolean getBoolean(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
is a repeating
attribute, the value at index 0 is returned. If attrName
is a repeating attribute without any
values, false
is returned.attrName
- The name of the attribute.java.lang.IllegalArgumentException
- If the attribute is not found for this object.getDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
double getDouble(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
is a repeating
attribute, the value at index 0 is returned. If attrName
is a repeating attribute without any
values, 0.0
is returned.attrName
- The name of the attribute.java.lang.IllegalArgumentException
- If the attribute is not found for this object.getBoolean(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
int getInt(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
is a repeating
attribute, the value at index 0 is returned. If attrName
is a repeating attribute without any
values, 0
is returned.attrName
- The name of the attribute.java.lang.IllegalArgumentException
- If the attribute is not found for this object.getBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
java.lang.String getString(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
is a repeating
attribute, the value at index 0 is returned. If attrName
is a repeating attribute without any
values, a zero-length string is returned.attrName
- The name of the attribute.java.lang.IllegalArgumentException
- If the attribute is not found for this object.getBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
IDfTime getTime(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
is a repeating
attribute, the value at index 0 is returned. If attrName
is a repeating attribute without any
values, DfTime.DF_nullDATE
is returned.attrName
- The name of the attribute.java.lang.IllegalArgumentException
- If the attribute is not found for this object.getBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getValue(java.lang.String)
IDfId getId(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
is a repeating
attribute, the value at index 0 is returned. If attrName
is a repeating attribute without any
values, DfId.DF_nullID
is returned.attrName
- The name of the attribute.java.lang.IllegalArgumentException
- If the attribute is not found for this object.getBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
boolean getRepeatingBoolean(java.lang.String attrName, int valueIndex) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
attrName
- The name of the repeating attribute.valueIndex
- The index position of the desired value.java.lang.IllegalArgumentException
- If the attribute is not found, or is not repeatingjava.lang.IndexOutOfBoundsException
- If the index is out of bounds.double getRepeatingDouble(java.lang.String attrName, int valueIndex) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
attrName
- The name of the repeating attribute.valueIndex
- The index position of the desired value.java.lang.IllegalArgumentException
- If the attribute is not found, or is not repeating.java.lang.IndexOutOfBoundsException
- If the index is out of bounds.int getRepeatingInt(java.lang.String attrName, int valueIndex) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
attrName
- The name of the repeating attribute.valueIndex
- The index position of the desired value.java.lang.IllegalArgumentException
- If the attribute is not found, or is not repeating.java.lang.IndexOutOfBoundsException
- If the index is out of bounds.java.lang.String getRepeatingString(java.lang.String attrName, int valueIndex) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
attrName
- The name of the repeating attribute.valueIndex
- The index position of the desired value.java.lang.IllegalArgumentException
- If the attribute is not found, or is not repeating.java.lang.IndexOutOfBoundsException
- If the index is out of bounds.IDfTime getRepeatingTime(java.lang.String attrName, int valueIndex) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
attrName
- The name of the repeating attribute.valueIndex
- The index position of the desired value.java.lang.IllegalArgumentException
- If the attribute is not found, or is not repeating.java.lang.IndexOutOfBoundsException
- If the index is out of bounds.java.lang.String getAllRepeatingStrings(java.lang.String attrName, java.lang.String separator) throws java.lang.IllegalArgumentException
separator
argument.attrName
- The name of the repeating attribute.separator
- The symbol to be used to separate the retrieved values of the repeating attribute. If
you specify null
as the separator, a comma will be used to separate the returned
values.java.lang.IllegalArgumentException
- If the attribute is not repeating.int findBoolean(java.lang.String attrName, boolean value) throws java.lang.IllegalArgumentException
attrName
- The name of the repeating attribute.value
- The boolean value to find.java.lang.IllegalArgumentException
- if the attribute is not repeating.int findDouble(java.lang.String attrName, double value) throws java.lang.IllegalArgumentException
attrName
- The name of the repeating attribute.value
- The double value to find.java.lang.IllegalArgumentException
- If the attribute is not repeating.int findId(java.lang.String attrName, IDfId value) throws java.lang.IllegalArgumentException
attrName
- The name of the repeating attribute.value
- The object ID to find.java.lang.IllegalArgumentException
- If the attribute is not repeating.int findInt(java.lang.String attrName, int value) throws java.lang.IllegalArgumentException
attrName
- The name of the repeating attribute.value
- The integer value to find.java.lang.IllegalArgumentException
- If the attribute is not repeating.int findString(java.lang.String attrName, java.lang.String value) throws java.lang.IllegalArgumentException
attrName
- The name of the repeating attribute.value
- The string value to find.java.lang.IllegalArgumentException
- If the attribute is not repeating.int findTime(java.lang.String attrName, IDfTime value) throws java.lang.IllegalArgumentException
attrName
- The name of the repeating attribute.value
- The time value to find.java.lang.IllegalArgumentException
- If the attribute is not repeating.int findValue(java.lang.String attrName, IDfValue value) throws java.lang.IllegalArgumentException
attrName
- The name of the repeating attribute.value
- The variant value to find.java.lang.IllegalArgumentException
- If the attribute is not repeating.int getValueCount(java.lang.String attrName)
attrName
- The name of the attribute.IDfEnumeration enumAttrs()
The enumeration interface is Java-specific. If you are
programming with COM, you need to do one of the following:
A. Call the methods of the Enumerator interface
through IDispatch.
The following sample code demonstrates option A in Visual Basic.
Object o =
my_object.enumAttrs() Dim attr as IDfAttr While o.hasMoreElements = true Set attr = o.nextElement name$ =
attr.getName Wend
B. Convert the interface to a IDfEnumeration interface by passing the
enumeration interface to the getEnumeration() method in IDfClientX.
The following sample code demonstrates
option B in Visual Basic.
Object o = my_object.enumAttrs() Dim en As IDfEnumeration Dim attr as
IDfAttr Set en = clientx.getEnumeration(o) While en.hasMoreElements = true
Set attr = en.nextElement
name$ = attr.getName Wend
int findAttrIndex(java.lang.String attrName)
attrName
- The attribute name.IDfAttr getAttr(int attrIndex) throws java.lang.IndexOutOfBoundsException
attrIndex
- The index of the attribute in the object list of attributes.java.lang.IndexOutOfBoundsException
- If the index is not within the bounds of this object list of attributes.findAttrIndex(java.lang.String)
int getAttrCount()
int getAttrDataType(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
- The name of the attribute.java.lang.IllegalArgumentException
- If the attribute is not found for this object.IDfAttr
boolean hasAttr(java.lang.String attrName)
attrName
- the name of the attributetrue
, if the specified attribute exists; false
, otherwise.boolean isAttrRepeating(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
is a repeating attribute. attrName
- The name of the attribute.true
, if the attribute is repeating; false
, otherwise.java.lang.IllegalArgumentException
- If the attribute is not found for this object.IDfValue getValueAt(int index) throws java.lang.IndexOutOfBoundsException
index
- The index of the attribute.java.lang.IndexOutOfBoundsException
- If the index is not within the bounds of this object list of attributes.getBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
,
getValue(java.lang.String)
long getLong(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
is a
repeating attribute, the value at index 0 is returned. If attrName
is a repeating attribute without
any values, 0
is returned.attrName
- The name of the attribute.java.lang.IllegalArgumentException
- If the attribute is not found for this object.long getRepeatingLong(java.lang.String attrName, int valueIndex) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
valueIndex
is 0.attrName
- The name of the repeating attribute.valueIndex
- The index position of the desired value.java.lang.IllegalArgumentException
- If the attribute is not found, or is not repeating.java.lang.IndexOutOfBoundsException
- If the index is out of bounds.IDfValue getValue(java.lang.String attrName) throws java.lang.IllegalArgumentException
attrName
- The name of the attribute.java.lang.IllegalArgumentException
- If the attribute is not found for this object.getBoolean(java.lang.String)
,
getDouble(java.lang.String)
,
getId(java.lang.String)
,
getInt(java.lang.String)
,
getString(java.lang.String)
,
getTime(java.lang.String)
IDfId getRepeatingId(java.lang.String attrName, int valueIndex) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
valueIndex
is 0.attrName
- The name of the repeating attribute.valueIndex
- The index position of the desired value.java.lang.IllegalArgumentException
- If the attribute is not found, or is not repeating.java.lang.IndexOutOfBoundsException
- If the index is out of bounds.IDfValue getRepeatingValue(java.lang.String attrName, int valueIndex) throws java.lang.IllegalArgumentException, java.lang.IndexOutOfBoundsException
valueIndex
is 0.attrName
- The name of the repeating attribute.valueIndex
- The index position of the desired value.java.lang.IllegalArgumentException
- If the attribute is not found, or is not repeating.java.lang.IndexOutOfBoundsException
- If the index is out of bounds.Copyright 1994-2023 OpenText Corporation. All rights reserved.