com.exalead.papi.framework.connectors.introspection

Class SuggestOption

java.lang.Object

com.exalead.papi.framework.connectors.introspection.SuggestOption

All Implemented Interfaces:

CVComponentConfig, IntrospectionQuery

public class SuggestOption
extends java.lang.Object
implements IntrospectionQuery

Used to ask a CVComponent to suggest possible values for one of its configuration key. Introspection query must return an instance of SuggestOption.SuggestResult

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SuggestOption.SuggestResult Result of this SuggestOption introspection query.

Constructor Summary

Constructors

Constructor and Description
SuggestOption()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getComponentName()
java.lang.String	getConfigKey() Path to option to suggest in the CVComponent configuration.
java.lang.String	getCurrentValue()
int	getLimit()
void	setComponentName(java.lang.String componentName) Specify component name to be fired.
void	setConfigKey(java.lang.String configKey)
void	setCurrentValue(java.lang.String currentValue)
void	setLimit(int limit) Set maximum number of values to be suggested.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SuggestOption

public SuggestOption()

Method Detail

getConfigKey

public java.lang.String getConfigKey()

Path to option to suggest in the CVComponent configuration. For example if the field is named "Option1" and is in the "Advanced" subsection, the following key will be given: Advanced.CustomProcessor.

Returns:

Path to option to suggest

setConfigKey

public void setConfigKey(java.lang.String configKey)

getCurrentValue

public java.lang.String getCurrentValue()

Returns:

get the current CVComponent option value

setCurrentValue

public void setCurrentValue(java.lang.String currentValue)

Parameters:

currentValue - Current CVComponent option value.

getLimit

public int getLimit()

Returns:

maximum number of values to suggest. 0 means "retrieve-all".

setLimit

public void setLimit(int limit)

Set maximum number of values to be suggested. 0 means "retrieve-all".

Parameters:

limit -

setComponentName

public void setComponentName(java.lang.String componentName)

Specify component name to be fired. For example the triggered connector name.

Parameters:

componentName -

getComponentName

public java.lang.String getComponentName()