com.endeca.portal.data.functions
Class SortConfig
java.lang.Object
com.endeca.portal.data.functions.QueryFunction
com.endeca.portal.data.functions.QueryConfig
com.endeca.portal.data.functions.SortConfig
- All Implemented Interfaces:
- java.io.Serializable, java.lang.Cloneable
public class SortConfig
- extends QueryConfig
Allow a sort to be applied to records returned from an executed QueryState.
If being used with a discovery service data source, this config's id property
should be equal to the id of the ResultsConfig it should apply to. By default,
it will apply to the default ResultsConfig.
- See Also:
- Serialized Form
Fields inherited from class com.endeca.portal.data.functions.QueryConfig |
id |
Constructor Summary |
protected |
SortConfig()
|
|
SortConfig(java.lang.String property)
|
|
SortConfig(java.lang.String property,
boolean ascending)
|
|
SortConfig(java.lang.String ownerId,
java.lang.String property)
|
|
SortConfig(java.lang.String ownerId,
java.lang.String property,
boolean ascending)
|
Method Summary |
void |
applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
Apply this function to a Request. |
java.lang.String |
getOwnerId()
|
java.lang.String |
getProperty()
|
boolean |
isAscending()
|
void |
setAscending(boolean ascending)
|
void |
setOwnerId(java.lang.String ownerId)
|
void |
setProperty(java.lang.String property)
|
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 |
SortConfig
protected SortConfig()
SortConfig
public SortConfig(java.lang.String property)
SortConfig
public SortConfig(java.lang.String ownerId,
java.lang.String property)
SortConfig
public SortConfig(java.lang.String property,
boolean ascending)
SortConfig
public SortConfig(java.lang.String ownerId,
java.lang.String property,
boolean ascending)
getProperty
public java.lang.String getProperty()
setProperty
public void setProperty(java.lang.String property)
isAscending
public boolean isAscending()
setAscending
public void setAscending(boolean ascending)
getOwnerId
public java.lang.String getOwnerId()
setOwnerId
public void setOwnerId(java.lang.String ownerId)
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