Package com.appiancorp.suiteapi.common

Class SuggestParam

java.lang.Object
com.appiancorp.suiteapi.common.SuggestParam
public class SuggestParam extends Object

  • Constructor Details

    • SuggestParam

      public SuggestParam()
      Default constructor

    • SuggestParam

      public SuggestParam(Long type, String[] displayProperties, String[] searchProperties, 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:

    • 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 Details

    • isRunSpaceQuery

      public boolean isRunSpaceQuery()
      Returns whether a "space query" should be executed when searching for suggestions.
      See Also:

    • 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

      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 Boolean getIncludeAllDescendants()

    • setIncludeAllDescendants

      public void setIncludeAllDescendants(Boolean includeAllDescendants)

    • getRootItems

      public LocalObject[] getRootItems()

    • setRootItems

      public void setRootItems(LocalObject[] rootItem)

    • getType

      public Long getType()

    • setType

      public void setType(Long type)

    • getDisplayProperties

      public String[] getDisplayProperties()

    • setDisplayProperties

      public void setDisplayProperties(String[] displayProperties)

    • getSortProperties

      public String[] getSortProperties()

    • setSortProperties

      public void setSortProperties(String[] sortProperties)

    • getFilters

      public SuggestParam.SuggestFilter[] getFilters()

    • setFilters

      public void setFilters(SuggestParam.SuggestFilter[] filters)

    • getSearchProperties

      public String[] getSearchProperties()

    • setSearchProperties

      public void setSearchProperties(String[] searchProperties)

    • fillInFromParent

      public void fillInFromParent(SuggestParam parent)