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

All Superinterfaces:

ICISObject, ICISObjectInitializable, ICISSearchResponse, ISCSObject, ISCSServerBinder, ISCSServerResponse, java.io.Serializable

public interface ISCSSearchResponse
extends ISCSServerResponse, ICISSearchResponse

Represents a response from a search query against 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.util.List	getConversionFormats(java.lang.String searchProvider)
int	getCount() Deprecated. use #getSearchQuery instead
int	getEndRow()
java.util.List	getNavigationPages()
java.lang.String	getQueryText() Deprecated. use #getSearchQuery instead
java.util.List	getResults()
java.util.List	getSearchProviders()
ISCSSearchQuery	getSearchQuery()
java.lang.String	getSortField() Deprecated. use #getSearchQuery instead
java.lang.String	getSortOrder() Deprecated. use #getSearchQuery instead
int	getStartRow() Deprecated. use #getSearchQuery instead
int	getTotalDocumentsProcessed()

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

getChangedSubjects, getChangedTopics, getFieldTypes, getMessage, getOptionList, getOptionLists, getRefreshSubjects, getUser, isCachedResponse

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

addResultSet, addStream, clearStreams, deserializeBinderFromHDA, getChangeMonitors, getDateFormat, getQuerySubjects, getResultSet, getResultSet, getResultSetColumnNames, getResultSetNames, getResultSetSingleRow, getResultSetSingleRow, getService, getStream, getStreamNames, getTimeZoneFromDateFormat, serializeBinderAsHDA, setChangeMonitors, setQuerySubjects, setService

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

getResults

java.util.List getResults()

Specified by:

getResults in interface ICISSearchResponse

Returns:

a list of ISCSSearchResult result objects

getNavigationPages

java.util.List getNavigationPages()

Returns:

a list of ISCSSearchNavigationPage objects

getCount

int getCount()

Deprecated. use #getSearchQuery instead

Returns:

the total number of results found

getTotalDocumentsProcessed

int getTotalDocumentsProcessed()

Returns:

the total number of documents processed during the query

getSortOrder

java.lang.String getSortOrder()

Deprecated. use #getSearchQuery instead

Returns:

the order the results are sorted by

getSortField

java.lang.String getSortField()

Deprecated. use #getSearchQuery instead

Returns:

The field that the results are sorted on.

getStartRow

int getStartRow()

Deprecated. use #getSearchQuery instead

Returns:

the number of the first row in this result set

getEndRow

int getEndRow()

Returns:

the number of the last row in this result set

getQueryText

java.lang.String getQueryText()

Deprecated. use #getSearchQuery instead

Returns:

the text that was used to generated this query

getSearchQuery

ISCSSearchQuery getSearchQuery()

Returns:

the query object that was used to generate these results

getSearchProviders

java.util.List getSearchProviders()

Returns:

a list of strings naming the registered search providers (i.e. idcm1, etc.)

getConversionFormats

java.util.List getConversionFormats(java.lang.String searchProvider)

Returns:

A list of document types that can be converted by dynamic converter.