com.plumtree.portaluiinfrastructure.search
Interface ISaveSearchModelRO

All Known Subinterfaces:

ISearchResultModelRO

All Known Implementing Classes:

SearchResultModel

public interface ISaveSearchModelRO

Author:

CraigS

Method Summary

boolean	GetHasBeenSaved() Returns true if this search has already been saved.
int	GetSavedSearchErrorCode() Returns an int that clients can set via ISaveSearchModel.setSavedSearchErrorCode() to communicate conditions like "a saved search already exists with that name".
java.lang.String	GetSavedSearchName() Returns the name of the search if the search has been saved, or null otherwise.

Method Detail

GetHasBeenSaved

boolean GetHasBeenSaved()

Returns true if this search has already been saved.

GetSavedSearchErrorCode

int GetSavedSearchErrorCode()

Returns an int that clients can set via ISaveSearchModel.setSavedSearchErrorCode() to communicate conditions like "a saved search already exists with that name". Default is zero.

GetSavedSearchName

java.lang.String GetSavedSearchName()

Returns the name of the search if the search has been saved, or null otherwise.