com.webmethods.caf.faces.search.saved

Interface ISavedSearch

All Superinterfaces:

ISelectItemProvider

All Known Implementing Classes:

SavedSearch

public interface ISavedSearch
extends ISelectItemProvider

Interface that save search implementations must implement

Method Summary

Modifier and Type	Method and Description
ISavedSearch	cloneSavedSearch() Clone this saved search
String	getDescription() Gets the description of the saved search
String	getDisplayName() Gets the display name of the saved search
String	getID() Gets the ID of the saved search
String	getQueryStateString() Gets the query state string
boolean	isDeletable() Returns whether the saved search is deletable by the current user
boolean	isPublic() Gets whether this is a public (shared) saved search
boolean	isUpdateable() Returns whether the save search is updateable by the current user
void	setDescription(String description) Sets the description of the saved search
void	setDisplayName(String displayName) Sets the display name of the saved search
void	setID(String id) Sets the ID of the saved search
void	setPublic(boolean newVal) Sets whether is saved search is a public (shared) saved search
void	setQueryStateString(String searchStateString) Sets the query state string

Methods inherited from interface com.webmethods.caf.faces.data.ISelectItemProvider

getIcon, getLabel, getStyle, getValue, isDisabled, isEscape

Method Detail

getID

String getID()

Gets the ID of the saved search

Returns:

saved search ID

setID

void setID(String id)

Sets the ID of the saved search

Parameters:

id - saved search ID

getDisplayName

String getDisplayName()

Gets the display name of the saved search

Returns:

saved search display name

setDisplayName

void setDisplayName(String displayName)

Sets the display name of the saved search

Parameters:

displayName - saved search display name

getDescription

String getDescription()

Gets the description of the saved search

Specified by:

getDescription in interface ISelectItemProvider

Returns:

saved search description

setDescription

void setDescription(String description)

Sets the description of the saved search

Parameters:

description - saved search description

getQueryStateString

String getQueryStateString()

Gets the query state string

Returns:

search query state string

setQueryStateString

void setQueryStateString(String searchStateString)

Sets the query state string

Parameters:

searchStateString - query state string

cloneSavedSearch

ISavedSearch cloneSavedSearch()

Clone this saved search

Returns:

clone of this saved search

isDeletable

boolean isDeletable()

Returns whether the saved search is deletable by the current user

Returns:

true if it is deletable, false otherwise

isUpdateable

boolean isUpdateable()

Returns whether the save search is updateable by the current user

Returns:

true if it is updateable, false otherwise

setPublic

void setPublic(boolean newVal)

Sets whether is saved search is a public (shared) saved search

Parameters:

newVal - true for a public search, false for a private search

isPublic

boolean isPublic()

Gets whether this is a public (shared) saved search

Returns:

true for a public search, false for a private search