com.stellent.cis.client.api.scs.search
Interface ISCSSearchQuery

All Superinterfaces:

ICISObject, ICISObjectInitializable, ISCSObject, java.io.Serializable

All Known Subinterfaces:

ISCSMultisortSearchQuery

public interface ISCSSearchQuery
extends ISCSObject

A query into the content server

Nested Class Summary

Nested classes/interfaces inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

ICISObjectInitializable.AdapterVersionAware

Field Summary

Fields inherited from interface com.stellent.cis.client.api.common.ICISObject

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

java.lang.String	getQueryFormat() The format of the query string (i.e.
java.lang.String	getQueryText()
int	getResultCount()
java.lang.String	getSearchEngine()
java.lang.String	getSortField()
java.lang.String	getSortOrder()
int	getStartRow()
void	setQueryFormat(java.lang.String queryFormat) Set the query format
void	setQueryText(java.lang.String queryText) Set the query text
void	setResultCount(int resultCount) Set the maximum number of results to return
void	setSearchEngine(java.lang.String searchEngine) Set the search engine to query against
void	setSortField(java.lang.String sortField) The field to used to sort the results
void	setSortOrder(java.lang.String sortOrder) The sorting order (ASC for ascending or DESC for descending)
void	setStartRow(int startRow) Set the starting row

Methods inherited from interface com.stellent.cis.client.api.scs.ISCSObject

castObject, clearPropertyFilter, copyObject, getPropertyFilter, getSourceAdapter, getSourceObject, getSourceObjectPropertyType, mergeObject, mergeObject, removeProperty, setPropertyFilter, setRestrictedPropertyFilter, setSourceObjectPropertyType

Methods inherited from interface com.stellent.cis.client.api.common.ICISObject

getProperties, getPropertiesWithValue, getProperty, getPropertyAsString, getPropertyAsString, getPropertyDescriptors, hasProperty, setProperty, setProperty, setProperty

Methods inherited from interface com.stellent.cis.client.api.common.ICISObjectInitializable

intialize

Method Detail

getQueryText

java.lang.String getQueryText()

Returns:

the query text

setQueryText

void setQueryText(java.lang.String queryText)

Set the query text

Parameters:

queryText - the query text

getResultCount

int getResultCount()

Returns:

the number of results to retrieve

setResultCount

void setResultCount(int resultCount)

Set the maximum number of results to return

Parameters:

resultCount - number of results

getStartRow

int getStartRow()

Returns:

the row to start returning results (allows for result paging)

setStartRow

void setStartRow(int startRow)

Set the starting row

Parameters:

startRow - the start row

getSortOrder

java.lang.String getSortOrder()

Returns:

the sort order

setSortOrder

void setSortOrder(java.lang.String sortOrder)

The sorting order (ASC for ascending or DESC for descending)

Parameters:

sortOrder - the sort order

getSortField

java.lang.String getSortField()

Returns:

the field used to sort the results

setSortField

void setSortField(java.lang.String sortField)

The field to used to sort the results

Parameters:

sortField - sort field

getQueryFormat

java.lang.String getQueryFormat()

The format of the query string (i.e. universal, database, etc.)

Returns:

the query format; if null the content server will assume the default

setQueryFormat

void setQueryFormat(java.lang.String queryFormat)

Set the query format

Parameters:

queryFormat - the format of the query text

getSearchEngine

java.lang.String getSearchEngine()

Returns:

the search engine to query (if null content server will query the default)

setSearchEngine

void setSearchEngine(java.lang.String searchEngine)

Set the search engine to query against

Parameters:

searchEngine - the search engine name