com.stellent.cis.client.api.sis.search
Interface ISISSearchResponse

All Superinterfaces:

ICISObject, ICISSearchResponse, java.io.Serializable

public interface ISISSearchResponse
extends ICISSearchResponse, ICISObject

Interface describes the response to a search request of a fixed system.

Field Summary

static int	COMPLETE
static int	ERROR
static int	NOQUERY
static int	PROCESSING Various search status constants
static int	QUERYSTOPPED

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

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

java.util.List	getColumnDescriptors() This method is the same as calling getColumnDescriptors (false)
int	getNumColumns()
int	getNumResults()
java.util.List	getResults()
ISISSearchCookie	getSearchCookie()
int	getSearchStatus()

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

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

Field Detail

PROCESSING

static final int PROCESSING

Various search status constants

See Also:

Constant Field Values

COMPLETE

static final int COMPLETE

See Also:

Constant Field Values

ERROR

static final int ERROR

See Also:

Constant Field Values

NOQUERY

static final int NOQUERY

See Also:

Constant Field Values

QUERYSTOPPED

static final int QUERYSTOPPED

See Also:

Constant Field Values

Method Detail

getResults

java.util.List getResults()

Specified by:

getResults in interface ICISSearchResponse

Returns:

The results of the search ISISContent

getSearchCookie

ISISSearchCookie getSearchCookie()

Returns:

An object that indicates the position within the search.

getSearchStatus

int getSearchStatus()

Returns:

The current status of the Search.

getColumnDescriptors

java.util.List getColumnDescriptors()

This method is the same as calling getColumnDescriptors (false)

Returns:

A list of descriptor objects for the columns ICISPropertyDescriptor

getNumResults

int getNumResults()

Returns:

The number of result items in this response object.

getNumColumns

int getNumColumns()

Returns:

The number of columns for each result item.