com.bowstreet.builders.webapp.api
Class IncrementalSearch

java.lang.Object
  com.bowstreet.builders.BaseBuilderAPI
      com.bowstreet.builders.webapp.api.IncrementalSearch

public class IncrementalSearch
extends com.bowstreet.builders.BaseBuilderAPI

Provides server-calculated suggestions to user as they type in a text box
Note: this is a builder API wrapper class, intended to be called by the regen logic of a builder. It can be used to programmatically add a call to the IncrementalSearch builder to a model.

Nested Class Summary

static interface

IncrementalSearch.BuilderStaticValues Constant values imported from the builder definition file.

Constructor Summary

IncrementalSearch(BuilderCall parent, GenContext gc)

Method Summary

java.lang.String	getAdditionalEventArgumentName() Name for optional argument to be passed to the selection event
java.lang.String	getAdditionalEventArgumentValue() Value for optional argument to be passed to the selection event
java.lang.String	getComparisonType() Use case-sensitive or case-insensitive comparisons Legal values: CaseInsensitive (Case insensitive), CaseSensitive (Case sensitive)
boolean	getEnableDataPaging() If checked, the view data will be displayed in fixed size pages; otherwise all data will be displayed at once.
java.lang.String	getFilterMode() How/whether to filter the list of results Legal values: Prefix (Show values starting with data), Includes (Show values containing data anywhere), None (Show all values)
java.lang.String	getLookupTable() Select a Lookup Table which will be used for the values.
java.lang.String	getMaxResults() The largest number of suggested results to return
java.lang.String	getName() Specify name of this builder call (required and must contain only alphanumeric characters and underscores)
java.lang.Object	getPageLocation() For instructions on operation or syntax of location definition string see Page Location help
java.lang.String	getPickerHeight() PickerHeight
java.lang.String	getPickerType() Select the UI created to display choices: a select list, a table, or a custom picker.
java.lang.String	getPickerUpdateAction() Select the action that will provide new HTML for the picker - called when the user data changes.
java.lang.String	getPickerWidth() PickerWidth
java.lang.String	getRowsPerPage() Data will be presented in chunks this big.
java.lang.String	getValueElement() Optional element name if list of values is XML based
java.lang.String	getValues() A reference returning a list of possible values
java.lang.String	getXMLType() Specify the schema of the input data
void	initializeBuilderInputs()
void	setAdditionalEventArgumentName(java.lang.String value) Name for optional argument to be passed to the selection event
void	setAdditionalEventArgumentValue(java.lang.String value) Value for optional argument to be passed to the selection event
void	setComparisonType(java.lang.String value) Use case-sensitive or case-insensitive comparisons Legal values: CaseInsensitive (Case insensitive), CaseSensitive (Case sensitive)
void	setEnableDataPaging(boolean value) If checked, the view data will be displayed in fixed size pages; otherwise all data will be displayed at once.
void	setFilterMode(java.lang.String value) How/whether to filter the list of results Legal values: Prefix (Show values starting with data), Includes (Show values containing data anywhere), None (Show all values)
void	setLookupTable(java.lang.String value) Select a Lookup Table which will be used for the values.
void	setMaxResults(java.lang.String value) The largest number of suggested results to return
void	setName(java.lang.String value) Specify name of this builder call (required and must contain only alphanumeric characters and underscores)
void	setPageLocation(java.lang.Object value) For instructions on operation or syntax of location definition string see Page Location help
void	setPickerHeight(java.lang.String value) PickerHeight
void	setPickerType(java.lang.String value) Select the UI created to display choices: a select list, a table, or a custom picker.
void	setPickerUpdateAction(java.lang.String value) Select the action that will provide new HTML for the picker - called when the user data changes.
void	setPickerWidth(java.lang.String value) PickerWidth
void	setRowsPerPage(java.lang.String value) Data will be presented in chunks this big.
void	setValueElement(java.lang.String value) Optional element name if list of values is XML based
void	setValues(java.lang.String value) A reference returning a list of possible values
void	setXMLType(java.lang.String value) Specify the schema of the input data

Methods inherited from class com.bowstreet.builders.BaseBuilderAPI

getBuilderCall, getBuilderInputs, invokeBuilder, invokeBuilderBC, setBuilderInputs

Methods inherited from class java.lang.Object

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

Constructor Detail

IncrementalSearch

public IncrementalSearch(BuilderCall parent,
                         GenContext gc)

Method Detail

getAdditionalEventArgumentName

public java.lang.String getAdditionalEventArgumentName()

Name for optional argument to be passed to the selection event

getAdditionalEventArgumentValue

public java.lang.String getAdditionalEventArgumentValue()

Value for optional argument to be passed to the selection event

getComparisonType

public java.lang.String getComparisonType()

Use case-sensitive or case-insensitive comparisons
Legal values: CaseInsensitive (Case insensitive), CaseSensitive (Case sensitive)

getEnableDataPaging

public boolean getEnableDataPaging()

If checked, the view data will be displayed in fixed size pages; otherwise all data will be displayed at once.

getFilterMode

public java.lang.String getFilterMode()

How/whether to filter the list of results
Legal values: Prefix (Show values starting with data), Includes (Show values containing data anywhere), None (Show all values)

getLookupTable

public java.lang.String getLookupTable()

Select a Lookup Table which will be used for the values.
Legal values:

getMaxResults

public java.lang.String getMaxResults()

The largest number of suggested results to return

getName

public java.lang.String getName()

Specify name of this builder call (required and must contain only alphanumeric characters and underscores)

getPageLocation

public java.lang.Object getPageLocation()

For instructions on operation or syntax of location definition string see Page Location help

getPickerHeight

public java.lang.String getPickerHeight()

PickerHeight

getPickerType

public java.lang.String getPickerType()

Select the UI created to display choices: a select list, a table, or a custom picker.
Legal values: Select (Select List), Table (Table), Custom (Custom)

getPickerUpdateAction

public java.lang.String getPickerUpdateAction()

Select the action that will provide new HTML for the picker - called when the user data changes.

getPickerWidth

public java.lang.String getPickerWidth()

PickerWidth

getRowsPerPage

public java.lang.String getRowsPerPage()

Data will be presented in chunks this big.

getValueElement

public java.lang.String getValueElement()

Optional element name if list of values is XML based

getValues

public java.lang.String getValues()

A reference returning a list of possible values

getXMLType

public java.lang.String getXMLType()

Specify the schema of the input data

initializeBuilderInputs

public void initializeBuilderInputs()

Overrides:

initializeBuilderInputs in class com.bowstreet.builders.BaseBuilderAPI

setAdditionalEventArgumentName

public void setAdditionalEventArgumentName(java.lang.String value)

Name for optional argument to be passed to the selection event

setAdditionalEventArgumentValue

public void setAdditionalEventArgumentValue(java.lang.String value)

Value for optional argument to be passed to the selection event

setComparisonType

public void setComparisonType(java.lang.String value)

Use case-sensitive or case-insensitive comparisons
Legal values: CaseInsensitive (Case insensitive), CaseSensitive (Case sensitive)

setEnableDataPaging

public void setEnableDataPaging(boolean value)

If checked, the view data will be displayed in fixed size pages; otherwise all data will be displayed at once.

setFilterMode

public void setFilterMode(java.lang.String value)

How/whether to filter the list of results
Legal values: Prefix (Show values starting with data), Includes (Show values containing data anywhere), None (Show all values)

setLookupTable

public void setLookupTable(java.lang.String value)

Select a Lookup Table which will be used for the values.
Legal values:

setMaxResults

public void setMaxResults(java.lang.String value)

The largest number of suggested results to return

setName

public void setName(java.lang.String value)

Specify name of this builder call (required and must contain only alphanumeric characters and underscores)

setPageLocation

public void setPageLocation(java.lang.Object value)

For instructions on operation or syntax of location definition string see Page Location help

setPickerHeight

public void setPickerHeight(java.lang.String value)

PickerHeight

setPickerType

public void setPickerType(java.lang.String value)

Select the UI created to display choices: a select list, a table, or a custom picker.
Legal values: Select (Select List), Table (Table), Custom (Custom)

setPickerUpdateAction

public void setPickerUpdateAction(java.lang.String value)

Select the action that will provide new HTML for the picker - called when the user data changes.

setPickerWidth

public void setPickerWidth(java.lang.String value)

PickerWidth

setRowsPerPage

public void setRowsPerPage(java.lang.String value)

Data will be presented in chunks this big.

setValueElement

public void setValueElement(java.lang.String value)

Optional element name if list of values is XML based

setValues

public void setValues(java.lang.String value)

A reference returning a list of possible values

setXMLType

public void setXMLType(java.lang.String value)

Specify the schema of the input data