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

All Superinterfaces:

ICISObject, ISISObject, java.io.Serializable

public interface ISISAdhocQuery
extends ISISObject

This allows the client to obtain a list of Prompts for the specified application.

Field Summary

static int	ALL
static int	DM
static int	FIELD
static int	FULLTEXT
static int	SYSTEM
static int	UNKNOWN

Fields inherited from interface com.stellent.cis.client.api.sis.ISISObject

OPERATOR_ADVSEARCH, OPERATOR_ALLVALUES, OPERATOR_AND, OPERATOR_BEGINSWITH, OPERATOR_CONTAINS, OPERATOR_ENDSWITH, OPERATOR_EQUAL, OPERATOR_EXACTPHRASE, OPERATOR_GREATERTHAN, OPERATOR_GREATERTHANEQUAL, OPERATOR_IN, OPERATOR_LESSTHAN, OPERATOR_LESSTHANEQUAL, OPERATOR_LIKE, OPERATOR_NOTBEGINSWITH, OPERATOR_NOTCONTAINS, OPERATOR_NOTENDSWITH, OPERATOR_NOTEQUAL, OPERATOR_NOTIN, OPERATOR_NOTLIKE, OPERATOR_OR, OPERATOR_SEARCH

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

FILTER_NULL_VALUE, FILTER_READONLY, FILTER_SYSTEM

Method Summary

ISISApplication	getApplication()
java.util.List	getComparisonOperators()
ISISLogicalOperator	getLogicalOperator()
java.util.List	getLogicalOperators()
ISISAdhocPrompt	getPrompt(java.lang.String name)
java.util.List	getPrompts()
void	setLogicalOperator(int type)
void	setLogicalOperator(ISISLogicalOperator logicalOperator)

Methods inherited from interface com.stellent.cis.client.api.sis.ISISObject

getErrorMessage, getObjectVersion, getSourceObject, getSourceObject, hasError

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

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

Field Detail

UNKNOWN

static final int UNKNOWN

See Also:

Constant Field Values

FIELD

static final int FIELD

See Also:

Constant Field Values

SYSTEM

static final int SYSTEM

See Also:

Constant Field Values

FULLTEXT

static final int FULLTEXT

See Also:

Constant Field Values

DM

static final int DM

See Also:

Constant Field Values

ALL

static final int ALL

See Also:

Constant Field Values

Method Detail

getLogicalOperators

java.util.List getLogicalOperators()

Returns:

A List of all the available logical operators that can be used in the LogicalOperator property. ISISLogicalOperator

getComparisonOperators

java.util.List getComparisonOperators()

Returns:

A List of all the available comparison operators that can be used in the prompts. ISISComparisonOperator

getApplication

ISISApplication getApplication()

Returns:

A description of the Application that this Index Definition corresponds to. No need to modify any of its properties when creating the document.

getLogicalOperator

ISISLogicalOperator getLogicalOperator()

Returns:

The logical operator that should be used to combine the prompt comparison. Use one of the available logical operators and set the Type property on this object. This defaults to AND which is a value of 0.

setLogicalOperator

void setLogicalOperator(ISISLogicalOperator logicalOperator)

Parameters:

logicalOperator - The logical operator that should be used to combine the prompt comparison. Use one of the available logical operators and set the Type property on this object. This defaults to AND which is a value of 0.

setLogicalOperator

void setLogicalOperator(int type)

Parameters:

type - The integer value that corresponds to the logical operator to use.

getPrompts

java.util.List getPrompts()

Returns:

A List of ad-hoc prompt objects representing each of the available prompts in the application. ISISAdhocPrompt

getPrompt

ISISAdhocPrompt getPrompt(java.lang.String name)

Parameters:

name - The name of the prompt to retrieve.

Returns:

The adhoc prompt object requested.