Package com.webmethods.common.search.form

Interface IRefineableFieldInfo

All Superinterfaces:
IDisplayFieldInfo
All Known Subinterfaces:
IRefineableFieldGroupInfo
public interface IRefineableFieldInfo extends IDisplayFieldInfo
Interface that provides the APIs for getting metadata about a refinable search field.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getColumnNumber()
    Gets the index of the desired column for the refine field
    int
    getColumnSpan()
    Gets the value of the column span property
    String
    getPropertyEditor()
    Return the name of the portal property editor to use to render the input field for this field
    Map<String,String>
    getPropertyEditorParameters()
    Return the parameters that should be passed to the portal property editor that is rendering this field.
    int
    getRowNumber()
    Gets the index of the desired row for the refine field
    void
    setColumnNumber(int column)
    Sets the index of the desired column for the refine field
    void
    setColumnSpan(int newSpan)
    Sets the value of the desired column span
    void
    setRowNumber(int row)
    Sets the index of the desired row for the refine field

    Methods inherited from interface com.webmethods.common.search.form.IDisplayFieldInfo

    getDisplayName, getFieldName

  • Method Details

    • getPropertyEditor

      String getPropertyEditor()
      Return the name of the portal property editor to use to render the input field for this field
      Returns:
      the name of a deployed portal property editor

    • getPropertyEditorParameters

      Map<String,String> getPropertyEditorParameters()
      Return the parameters that should be passed to the portal property editor that is rendering this field.
      Returns:
      map of property editor parameters

    • getRowNumber

      int getRowNumber()
      Gets the index of the desired row for the refine field
      Returns:
      index of desired row

    • getColumnNumber

      int getColumnNumber()
      Gets the index of the desired column for the refine field
      Returns:
      index of desired column

    • getColumnSpan

      int getColumnSpan()
      Gets the value of the column span property
      Returns:
      the value as int

    • setRowNumber

      void setRowNumber(int row)
      Sets the index of the desired row for the refine field

    • setColumnNumber

      void setColumnNumber(int column)
      Sets the index of the desired column for the refine field

    • setColumnSpan

      void setColumnSpan(int newSpan)
      Sets the value of the desired column span