|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.mdm.index.querybuilder.SearchOptions
com.sun.mdm.index.master.search.enterprise.EOSearchOptions
The EOSearchOptions class represents a specific sub-class of the SearchOptions class, and is used by searchEnterpriseObject as criteria for an enterprise object search. Methods in this class use fully qualified field names (see Creating a Master Index with Master Index Studio for more information about field names).
Field Summary |
Fields inherited from class com.sun.mdm.index.querybuilder.SearchOptions |
mMaxElements, mPageSize |
Constructor Summary | |
EOSearchOptions()
Creates a new instance of the EOSearchOptions class. |
|
EOSearchOptions(java.lang.String searchId,
EPathArrayList fields)
Creates a new instance of the EOSearchOptions class. |
Method Summary | |
int |
getCandidateThreshold()
Retrieves the value set by the setMaximumRows, which determines the maximuim rows that can be returned. |
EPathArrayList |
getFieldsToRetrieve()
Retrieves an array of fully qualified field names pointing to the location of the fields to retrieve from a search for an enterprise object. |
java.lang.String |
getSearchId()
Retrieves the value of the search ID (query name) defined in an EOSearchOptions object. |
boolean |
isWeighted()
Retrieves the value set by the setWeighted class, which determines whether query results are weighted. |
void |
setCandidateThreshold(int count)
Set the maximum row to return. |
void |
setFieldsToRetrieve(EPathArrayList fields)
Sets the fields to retrieve for an enterprise object search, using the ePaths of the fields. |
void |
setSearchId(java.lang.String searchId)
Sets the search ID (the name of the query) for an enterprise object search. |
void |
setWeighted(boolean weighted)
Specifies whether query results are weighted. |
java.lang.String |
toString()
String representation |
Methods inherited from class com.sun.mdm.index.querybuilder.SearchOptions |
getBooleanOption, getMaxElements, getMaxQueryElements, getOption, getOptionNames, getPageSize, setMaxElements, setMaxQueryElements, setOption, setPageSize |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public EOSearchOptions() throws ConfigurationException
ConfigurationException
- Thrown when a parameter is invalid.public EOSearchOptions(java.lang.String searchId, EPathArrayList fields) throws ConfigurationException
searchId
- The name of the query to be used. The possible values for
this parameter are defined in the Candidate Select configuration file.fields
- An array of fully qualified field names pointing to the fields
to retrieve for the query. Fully qualified field names allow you to define
fields within the context of the enterprise object; that is, the field name
uses "Enterprise" as the root. For example,
Enterprise.SystemSBR.Person.FirstName.
ConfigurationException
- Thrown when a parameter is invalid.Method Detail |
public int getCandidateThreshold()
public EPathArrayList getFieldsToRetrieve() throws ConfigurationException
EPathArrayList
- An array containing the fully qualified
field names for the fields to retrieve.
ConfigurationException
- Thrown when a parameter is invalid.public java.lang.String getSearchId()
public boolean isWeighted()
public void setCandidateThreshold(int count)
count
- Maximum rows
void
- None.
ConfigurationException
- Thrown when a parameter is invalid.public void setFieldsToRetrieve(EPathArrayList fields) throws ConfigurationException
fields
- An array containing the fully qualified field names for
the fields to retrieve.
void
- None.
ConfigurationException
- Thrown when a parameter is invalid.public void setSearchId(java.lang.String searchId)
searchId
- A query name (available names are defined in the
Candidate Select configuration file).
void
- None.
public void setWeighted(boolean weighted) throws ConfigurationException
weighted
- if enabled, query results are forwarded to MEFA
void
- None.
ConfigurationException
- Thrown when a parameter is invalid.public java.lang.String toString()
toString
in class SearchOptions
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Sun Microsystems, Inc.