Collaboration API Documentation

com.filenet.bso.api.util
Class BsoSearchResultsClassData

java.lang.Object
  |
  +--com.filenet.bso.api.util.BsoSearchResultsClassData

public final class BsoSearchResultsClassData
extends java.lang.Object

An instance of this class provides information about a class represented in some search results.


Constructor Summary
BsoSearchResultsClassData(java.lang.String classPrefix, java.lang.String[] classKeys, java.lang.String identCol, java.lang.String[] refedClasses)
          Construct a class data instance.
BsoSearchResultsClassData(java.lang.String classPrefix, java.lang.String identCol, java.lang.String[] refedClasses)
          Construct a class data instance.
 
Method Summary
 java.lang.String[] getClassKeys()
           
 java.lang.String getClassPrefix()
          Returns the prefix that represents this class.
 java.lang.String getIdentityColumn()
          Returns the name of the identity column for this class.
 java.lang.String[] getReferencedClasses()
          Returns the prefixes of any classes referenced from this class.
 boolean isIdentifiedBy(java.lang.String classIdent)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BsoSearchResultsClassData

public BsoSearchResultsClassData(java.lang.String classPrefix,
                                 java.lang.String[] classKeys,
                                 java.lang.String identCol,
                                 java.lang.String[] refedClasses)
Construct a class data instance.
Parameters:
classPrefix - Required, a prefix that represents a class. Each column from the class in the search results must have an alias name that begins with this prefix. If any keys are specified in the classKeys argument, this prefix cannot be the same as any of those keys.

This can, however be an empty prefix. So you could specify a single class with an empty prefix and specify keys for that class.

classKeys - Optional, one or more keys that represent this class. These keys allow code to be written that refers to a class with a general key, but more specific keys can provide context of where this class sits in a query. For example it could be the primary class being searched for or it may be a class joined with that class for some additional context.
identCol - Optional, the column name that represents the identity column for the class. This is typically Id. This is used to determine duplicate virtual rows in the search results. If null, all columns combined determine identical rows. You would typically only use this when selecting a small number of columns from a non-persistent class such as ContentSearch.
refedClasses - Optional, the prefixes of any classes that this class references. If specified, the rows for those other classes can be accessed from a row for this class using BsoSearchResultRow.getReferencedClassRowCount(), etc.

BsoSearchResultsClassData

public BsoSearchResultsClassData(java.lang.String classPrefix,
                                 java.lang.String identCol,
                                 java.lang.String[] refedClasses)
Construct a class data instance. This variation is the same as calling BsoSearchResultsClassData(classPrefix, null, identCol, refedClasses.
Method Detail

getClassPrefix

public java.lang.String getClassPrefix()
Returns the prefix that represents this class.

getIdentityColumn

public java.lang.String getIdentityColumn()
Returns the name of the identity column for this class.

getClassKeys

public java.lang.String[] getClassKeys()

isIdentifiedBy

public boolean isIdentifiedBy(java.lang.String classIdent)

getReferencedClasses

public java.lang.String[] getReferencedClasses()
Returns the prefixes of any classes referenced from this class.

Collaboration API Documentation

Copyright © 2002 - 2004 FileNet Corporation. All rights reserved.