com.appiancorp.suiteapi.common

Class SuggestParam

java.lang.Object

com.appiancorp.suiteapi.common.SuggestParam

public class SuggestParam
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SuggestParam.SuggestFilter

Constructor Summary

Constructors

Constructor and Description
SuggestParam() Default constructor
SuggestParam(java.lang.Long type, java.lang.String[] displayProperties, java.lang.String[] searchProperties, java.lang.String[] sortProperties) Constructs a new instance.
SuggestParam(SuggestParam param) Convenience creator used for cloning SuggestParam instances.

Method Summary

Modifier and Type	Method and Description
void	fillInFromParent(SuggestParam parent)
java.lang.String[]	getDisplayProperties()
SuggestParam.SuggestFilter[]	getFilters()
java.lang.Boolean	getIncludeAllDescendants()
LocalObject[]	getRootItems()
java.lang.String[]	getSearchProperties()
java.lang.String[]	getSortProperties()
java.lang.Long	getType()
boolean	isRunContainsQuery() Returns whether a "contains query" should be executed when searching for suggestions.
boolean	isRunSpaceQuery() Returns whether a "space query" should be executed when searching for suggestions.
void	setDisplayProperties(java.lang.String[] displayProperties)
void	setFilters(SuggestParam.SuggestFilter[] filters)
void	setIncludeAllDescendants(java.lang.Boolean includeAllDescendants)
void	setRootItems(LocalObject[] rootItem)
void	setRunContainsQuery(boolean runContainsQuery) Specify whether a "contains query" should be executed when searching for suggestions.
void	setRunSpaceQuery(boolean runSpaceQuery) Specify whether a "space query" should be executed when searching for suggestions.
void	setSearchProperties(java.lang.String[] searchProperties)
void	setSortProperties(java.lang.String[] sortProperties)
void	setType(java.lang.Long type)

Methods inherited from class java.lang.Object

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

Constructor Detail

SuggestParam

public SuggestParam()

Default constructor

SuggestParam

public SuggestParam(java.lang.Long type,
                    java.lang.String[] displayProperties,
                    java.lang.String[] searchProperties,
                    java.lang.String[] sortProperties)

Constructs a new instance.

Parameters:

type - the Appian type this suggest represents

displayProperties - the list of display properties; these are the properties being requested for the type

searchProperties - the list of object properties to search across

sortProperties - the list of object properties that are sortable for suggest requests

See Also:

AppianType

SuggestParam

public SuggestParam(SuggestParam param)

Convenience creator used for cloning SuggestParam instances. This creator is useful when you intend to copy and edit a constant param template.

Method Detail

isRunSpaceQuery

public boolean isRunSpaceQuery()

Returns whether a "space query" should be executed when searching for suggestions.

See Also:

setRunSpaceQuery(boolean)

setRunSpaceQuery

public void setRunSpaceQuery(boolean runSpaceQuery)

Specify whether a "space query" should be executed when searching for suggestions. Executing a space query allows matching items whose name does not start with the search term, but whose name contains the search term somewhere in the middle and after a space. For example, given the items ["Date", "Time", "Date and Time", "MyTimeDataType", "MyDataType (Time)"] and the search term "time": - Without space query enabled, the results will be 1 item: ["Time"]. - With space query enabled, the results will be 2 items: ["Time", "Date and Time"].

Parameters:

runSpaceQuery - true if a "space query" should be executed, and false otherwise

isRunContainsQuery

public boolean isRunContainsQuery()

Returns whether a "contains query" should be executed when searching for suggestions.

See Also:

setRunContainsQuery(boolean)

setRunContainsQuery

public void setRunContainsQuery(boolean runContainsQuery)

Specify whether a "contains query" should be executed when searching for suggestions. Executing a contains query allows matching items whose names do not start with the search term, but whose name contains the search term somewhere in the middle.

Parameters:

runContainsQuery - true if a "contains query" should be executed, and false otherwise

getIncludeAllDescendants

public java.lang.Boolean getIncludeAllDescendants()

setIncludeAllDescendants

public void setIncludeAllDescendants(java.lang.Boolean includeAllDescendants)

getRootItems

public LocalObject[] getRootItems()

setRootItems

public void setRootItems(LocalObject[] rootItem)

getType

public java.lang.Long getType()

setType

public void setType(java.lang.Long type)

getDisplayProperties

public java.lang.String[] getDisplayProperties()

setDisplayProperties

public void setDisplayProperties(java.lang.String[] displayProperties)

getSortProperties

public java.lang.String[] getSortProperties()

setSortProperties

public void setSortProperties(java.lang.String[] sortProperties)

getFilters

public SuggestParam.SuggestFilter[] getFilters()

setFilters

public void setFilters(SuggestParam.SuggestFilter[] filters)

getSearchProperties

public java.lang.String[] getSearchProperties()

setSearchProperties

public void setSearchProperties(java.lang.String[] searchProperties)

fillInFromParent

public void fillInFromParent(SuggestParam parent)