Package com.webmethods.caf.faces.search.saved

Class SavedSearch

java.lang.Object
javax.faces.model.SelectItem
com.webmethods.caf.faces.search.saved.SavedSearch
All Implemented Interfaces:
ISelectItemProvider, ISavedSearch, Serializable, Cloneable
public class SavedSearch extends SelectItem implements ISavedSearch, Cloneable, Serializable
Default implementation of ISavedSearch
See Also:

  • Field Details

    • fID

      protected String fID

    • fDisplayName

      protected String fDisplayName

    • fDescription

      protected String fDescription

    • fQueryStateString

      protected String fQueryStateString

    • fDeletable

      protected boolean fDeletable

    • fUpdateable

      protected boolean fUpdateable

    • fPublic

      protected boolean fPublic

  • Constructor Details

    • SavedSearch

      public SavedSearch()

    • SavedSearch

      public SavedSearch(Map<String,String> stateMap)

  • Method Details

    • populateFromStateMap

      public void populateFromStateMap(Map<String,String> stateMap)

    • getID

      public String getID()
      Description copied from interface: ISavedSearch
      Gets the ID of the saved search
      Specified by:
      getID in interface ISavedSearch
      Returns:
      saved search ID

    • setID

      public void setID(String id)
      Description copied from interface: ISavedSearch
      Sets the ID of the saved search
      Specified by:
      setID in interface ISavedSearch
      Parameters:
      id - saved search ID

    • getDisplayName

      public String getDisplayName()
      Description copied from interface: ISavedSearch
      Gets the display name of the saved search
      Specified by:
      getDisplayName in interface ISavedSearch
      Returns:
      saved search display name

    • setDisplayName

      public void setDisplayName(String displayName)
      Description copied from interface: ISavedSearch
      Sets the display name of the saved search
      Specified by:
      setDisplayName in interface ISavedSearch
      Parameters:
      displayName - saved search display name

    • getDescription

      public String getDescription()
      Description copied from interface: ISavedSearch
      Gets the description of the saved search
      Specified by:
      getDescription in interface ISavedSearch
      Specified by:
      getDescription in interface ISelectItemProvider
      Overrides:
      getDescription in class SelectItem
      Returns:
      saved search description

    • setDescription

      public void setDescription(String description)
      Description copied from interface: ISavedSearch
      Sets the description of the saved search
      Specified by:
      setDescription in interface ISavedSearch
      Overrides:
      setDescription in class SelectItem
      Parameters:
      description - saved search description

    • getQueryStateString

      public String getQueryStateString()
      Description copied from interface: ISavedSearch
      Gets the query state string
      Specified by:
      getQueryStateString in interface ISavedSearch
      Returns:
      search query state string

    • setQueryStateString

      public void setQueryStateString(String queryStateString)
      Description copied from interface: ISavedSearch
      Sets the query state string
      Specified by:
      setQueryStateString in interface ISavedSearch
      Parameters:
      queryStateString - query state string

    • isDeletable

      public boolean isDeletable()
      Description copied from interface: ISavedSearch
      Returns whether the saved search is deletable by the current user
      Specified by:
      isDeletable in interface ISavedSearch
      Returns:
      true if it is deletable, false otherwise

    • setDeletable

      public void setDeletable(boolean deletable)
      Parameters:
      deletable - The deletable to set.

    • isUpdateable

      public boolean isUpdateable()
      Description copied from interface: ISavedSearch
      Returns whether the save search is updateable by the current user
      Specified by:
      isUpdateable in interface ISavedSearch
      Returns:
      true if it is updateable, false otherwise

    • isPublic

      public boolean isPublic()
      Description copied from interface: ISavedSearch
      Gets whether this is a public (shared) saved search
      Specified by:
      isPublic in interface ISavedSearch
      Returns:
      true for a public search, false for a private search

    • setPublic

      public void setPublic(boolean newVal)
      Description copied from interface: ISavedSearch
      Sets whether is saved search is a public (shared) saved search
      Specified by:
      setPublic in interface ISavedSearch
      Parameters:
      newVal - true for a public search, false for a private search

    • setUpdateable

      public void setUpdateable(boolean updateable)
      Parameters:
      updateable - The updateable to set.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • cloneSavedSearch

      public ISavedSearch cloneSavedSearch()
      Description copied from interface: ISavedSearch
      Clone this saved search
      Specified by:
      cloneSavedSearch in interface ISavedSearch
      Returns:
      clone of this saved search

    • getValue

      public Object getValue()
      Description copied from interface: ISelectItemProvider
      Returns item's value, used for data binding, typically a unique identifier.
      Specified by:
      getValue in interface ISelectItemProvider
      Overrides:
      getValue in class SelectItem
      Returns:
      item's value

    • getLabel

      public String getLabel()
      Description copied from interface: ISelectItemProvider
      Returns item's display name, typically used in the UI to diplay this item
      Specified by:
      getLabel in interface ISelectItemProvider
      Overrides:
      getLabel in class SelectItem
      Returns:
      item's label

    • isDisabled

      public boolean isDisabled()
      Description copied from interface: ISelectItemProvider
      Returns true if item is disabled.
      Specified by:
      isDisabled in interface ISelectItemProvider
      Overrides:
      isDisabled in class SelectItem
      Returns:
      disabled status

    • getStyle

      public String getStyle()
      Description copied from interface: ISelectItemProvider
      Returns item's inline CSS style.
      Specified by:
      getStyle in interface ISelectItemProvider
      Returns:
      items's CSS style

    • getIcon

      public String getIcon()
      Description copied from interface: ISelectItemProvider
      Returns item's encoded icon URL.
      Specified by:
      getIcon in interface ISelectItemProvider
      Returns:
      icon url

    • isEscape

      public boolean isEscape()
      Description copied from interface: ISelectItemProvider
      Returns true if item label should be escaped.
      Specified by:
      isEscape in interface ISelectItemProvider
      Overrides:
      isEscape in class SelectItem
      Returns:
      true or false