com.endeca.portal.data.functions
Class SearchAdjustmentsConfig
java.lang.Object
com.endeca.portal.data.functions.QueryFunction
com.endeca.portal.data.functions.QueryConfig
com.endeca.portal.data.functions.SearchAdjustmentsConfig
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable
public class SearchAdjustmentsConfig
- extends QueryConfig
Configure how search adjustments will be returned on the QueryState's executed
results.
This config only works on discovery service data sources, and resolves to a
no-op on ENE presentation API data sources.
- See Also:
- Serialized Form
Fields inherited from class com.endeca.portal.data.functions.QueryConfig |
id |
Method Summary |
void |
applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
Apply this function to a Request. |
java.lang.String |
toString()
This class' toString is abstract: all concrete subclasses are expected
to provide an implementation. toString is used in comparing QueryFunction
instances for equality, so if you implement a QueryFunction subclass
it is important that your toString implementation be consistent and
deterministic. |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
DEFAULT_ID
public static final java.lang.String DEFAULT_ID
- See Also:
- Constant Field Values
HANDLER_FUNCTION
public static final java.lang.String HANDLER_FUNCTION
- See Also:
- Constant Field Values
SearchAdjustmentsConfig
public SearchAdjustmentsConfig()
- Constructor.
SearchAdjustmentsConfig
public SearchAdjustmentsConfig(java.lang.String id)
- Instantiate the search adjustments with the specified ID.
- Parameters:
id
-
applyToDiscoveryServiceQuery
public void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
throws QueryFunctionUnsupportedException
- Description copied from class:
QueryFunction
- Apply this function to a Request. Must be implemented by subclass.
- Specified by:
applyToDiscoveryServiceQuery
in class QueryFunction
- Throws:
QueryFunctionUnsupportedException
toString
public java.lang.String toString()
- Description copied from class:
QueryFunction
- This class' toString is abstract: all concrete subclasses are expected
to provide an implementation. toString is used in comparing QueryFunction
instances for equality, so if you implement a QueryFunction subclass
it is important that your toString implementation be consistent and
deterministic.
- Specified by:
toString
in class QueryFunction