SuggestParms

java.lang.Object

com.ptc.core.components.suggest.SuggestParms

All Implemented Interfaces:: Serializable

public final class SuggestParms extends Object implements Serializable

This represents the information to carry out a suggest search.

Supported API: true

Extendable: false

See Also:

Method Summary

Modifier and Type

Method

Description

NmCommandBean

getCommandBean()

Gets the command bean

Supported API: true

int

getMaxResults()

Gets the maximum results desired.

String

getSearchTerm()

Gets the term to search for.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details
- getMaxResults
  
  public int getMaxResults()
  
  Gets the maximum results desired.
  
  Supported API: true
  
  Returns:
  
  maxResults the maximum results desired
- getSearchTerm
  
  public String getSearchTerm()
  
  Gets the term to search for.
  
  Supported API: true
  
  Returns:
  
  searchTerm a String representing the searchTerm of this element
- getCommandBean
  
  public NmCommandBean getCommandBean()
  
  Gets the command bean
  
  Supported API: true
  
  Returns:
  
  commandBean