|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.filenet.bso.api.util.BsoSearchResultRow
An instance of this class represents a row of some search results. This can be an actual row from the results or a virtual row representing only the columns for a particular class.
Constructor Summary | |
BsoSearchResultRow(BsoSearchResultsClassData thisClassData,
BsoSearchResultsClassData[] referencedClassDatas)
Constructor that takes directly a BsoSearchResultsClassData
object that represents the class for this row and an array of
BsoSearchResultsClassData objects that represent any classes
for rows this row may reference. |
|
BsoSearchResultRow(java.lang.String classIdent,
BsoSearchResultsClassData[] classDatas)
Construct an instance of the BsoSearchResultRow class. |
Method Summary | |
void |
addReferencedClassRow(BsoSearchResultRow refedRow)
Adds a row for a referenced class to this row. |
boolean |
canReferenceClass(java.lang.String classIdent)
Method to determine if it is possible for this row to even reference rows from another class. |
BsoSearchResultsClassData |
getClassData()
Returns the class data for the class associated with this row. |
int |
getColumnCount()
Returns the number of columns in this row. |
java.lang.String |
getColumnName(int columnIdx)
Returns the column name for a particular column number. |
java.lang.String |
getColumnType(int columnIdx)
Returns the column type for a particular column number. |
java.lang.String |
getColumnType(java.lang.String columnName)
Returns the column type for a particular column name. |
java.lang.String |
getColumnValue(int columnIdx)
Returns the column value for a particular column number. |
java.lang.String |
getColumnValue(java.lang.String columnName)
Returns the column value for a particular column name. |
BsoSearchResultRow |
getReferencedClassRow(java.lang.String classIdent)
Gets the single row for a class referenced from this class. |
BsoSearchResultRow |
getReferencedClassRow(java.lang.String classIdent,
int idx)
Gets a row from a class referenced from this row. |
BsoSearchResultRow |
getReferencedClassRow(java.lang.String classIdent,
java.lang.String ident)
Gets a row from a class referenced from this class. |
int |
getReferencedClassRowCount(java.lang.String classIdent)
Gets the number of rows referenced by this row for another class. |
static BsoSearchResultRow |
getRowCanReferenceClass(BsoSearchResultRow[] rows,
java.lang.String classKey)
|
static BsoSearchResultRow |
getRowCanReferenceClassFromRowOrRows(java.lang.Object rowOrRows,
java.lang.String classKey)
|
static BsoSearchResultRow |
getRowHasColumn(BsoSearchResultRow[] rows,
java.lang.String propName)
|
static BsoSearchResultRow |
getRowHasColumnFromRowOrRows(java.lang.Object rowOrRows,
java.lang.String propName)
|
static BsoSearchResultRow |
getRowWithClassIdentifiedByKey(BsoSearchResultRow[] rows,
java.lang.String classKey)
|
static BsoSearchResultRow |
getRowWithClassIdentifiedByKeyFromRowOrRows(java.lang.Object rowOrRows,
java.lang.String classKey)
|
boolean |
hasColumn(java.lang.String columnName)
Determines if a row has a column of a particular name. |
boolean |
hasReferencedClassRow(java.lang.String classIdent,
java.lang.String ident)
Determines if this row references a particular row for another class. |
void |
setColumn(java.lang.String columnName,
java.lang.String columnType,
java.lang.String columnValue)
Sets a column on the row. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public BsoSearchResultRow(java.lang.String classIdent, BsoSearchResultsClassData[] classDatas)
BsoSearchResultRow
class.classIdent
- Optional, a class identifier if multiple classes are
involved in the query. The identifier can be the
class prefix or one of the keys specified for the class.
If null, the empty prefix is assumed.classDatas
- Optional, class data objects. This array must include
at least class data for the above class identifier as
well as data for any classes that this class references.
It doesn't hurt to pass in more objects than are
required for this class.
If null, a class data structure with an empty prefix
is assumed.public BsoSearchResultRow(BsoSearchResultsClassData thisClassData, BsoSearchResultsClassData[] referencedClassDatas)
BsoSearchResultsClassData
object that represents the class for this row and an array of
BsoSearchResultsClassData
objects that represent any classes
for rows this row may reference. The variation of the constructor
BsoSearchResultRow(String, BsoSearchResultsClassData[])
internally internally breaks out the objects into these two variables.
This constructor is important when merging multiple rows together into
a single row, and references to other rows. In particular, the keys used
to identify the class for this row may overlap with keys used to identify
classes for referenced rows. It is possible for a particular object to show
up as both the primary class being searched and as an object referenced
from another object.thisClassData
- referencedClassDatas
- Method Detail |
public static BsoSearchResultRow getRowCanReferenceClass(BsoSearchResultRow[] rows, java.lang.String classKey)
public static BsoSearchResultRow getRowCanReferenceClassFromRowOrRows(java.lang.Object rowOrRows, java.lang.String classKey)
public static BsoSearchResultRow getRowHasColumn(BsoSearchResultRow[] rows, java.lang.String propName)
public static BsoSearchResultRow getRowHasColumnFromRowOrRows(java.lang.Object rowOrRows, java.lang.String propName)
public static BsoSearchResultRow getRowWithClassIdentifiedByKey(BsoSearchResultRow[] rows, java.lang.String classKey)
public static BsoSearchResultRow getRowWithClassIdentifiedByKeyFromRowOrRows(java.lang.Object rowOrRows, java.lang.String classKey)
public BsoSearchResultsClassData getClassData()
public void setColumn(java.lang.String columnName, java.lang.String columnType, java.lang.String columnValue)
public int getColumnCount()
public boolean hasColumn(java.lang.String columnName)
public java.lang.String getColumnValue(java.lang.String columnName)
public java.lang.String getColumnType(java.lang.String columnName)
public java.lang.String getColumnName(int columnIdx)
public java.lang.String getColumnValue(int columnIdx)
public java.lang.String getColumnType(int columnIdx)
public void addReferencedClassRow(BsoSearchResultRow refedRow)
public boolean canReferenceClass(java.lang.String classIdent)
classIdent
- public boolean hasReferencedClassRow(java.lang.String classIdent, java.lang.String ident)
classIdent
- Class identifier that represents the referenced class.
Can be either the class prefix or one of the keys
specified for the class.ident
- The value of the identity column for the row of the
other class.public int getReferencedClassRowCount(java.lang.String classIdent)
classIdent
- Class identifier that represents the referenced class.
Can be either the class prefix or one of the keys
specified for the class.public BsoSearchResultRow getReferencedClassRow(java.lang.String classIdent, int idx)
classIdent
- Class identifier that represents the referenced class.
Can be either the class prefix or one of the keys
specified for the class.idx
- Index of the row to return.public BsoSearchResultRow getReferencedClassRow(java.lang.String classIdent, java.lang.String ident)
classIdent
- Class identifier that represents the referenced class.
Can be either the class prefix or one of the keys
specified for the class.ident
- Value of the identity column of the row to fetch.public BsoSearchResultRow getReferencedClassRow(java.lang.String classIdent)
|
Collaboration API Documentation | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |