com.flexive.shared.search
Interface ResultLocation

All Superinterfaces:
ObjectWithLabel, java.io.Serializable
All Known Implementing Classes:
AdminResultLocations

public interface ResultLocation
extends ObjectWithLabel, java.io.Serializable

Interface for query result locations

Version:
$Rev: 2919 $
Author:
Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)

Method Summary
 FxString getLabel()
          Return the localized label of the object.
 java.lang.String getName()
           
 boolean isCacheInSession()
          Returns true if the last search result for the given location should be cached in the user session.
 

Method Detail

getLabel

FxString getLabel()
Description copied from interface: ObjectWithLabel
Return the localized label of the object.

Specified by:
getLabel in interface ObjectWithLabel
Returns:
the localized label for the object.

getName

java.lang.String getName()

isCacheInSession

boolean isCacheInSession()
Returns true if the last search result for the given location should be cached in the user session. This feature is implemented in the web layer, not in the core engines - for example, if you use the JSF components' SearchResultBean, the last search result will be cached if this flag is set for the result location.

Returns:
true if results for the given location should be cached in the user session
Since:
3.1