com.endeca.portal.data.functions
Class ResultsConfig

java.lang.Object
  com.endeca.portal.data.functions.QueryFunction
      com.endeca.portal.data.functions.QueryConfig
          com.endeca.portal.data.functions.ResultsConfig

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ResultsConfig
extends QueryConfig

Configure how results will be returned from the results of an executed QueryState.

See Also:

Serialized Form

Field Summary

static java.lang.String	DEFAULT_ID
static java.lang.String	HANDLER_FUNCTION

Fields inherited from class com.endeca.portal.data.functions.QueryConfig

id

Fields inherited from class com.endeca.portal.data.functions.QueryFunction

CLASS_PROPERTY

Constructor Summary

ResultsConfig()

ResultsConfig(long recordsPerPage)

ResultsConfig(java.lang.String id)

ResultsConfig(java.lang.String id, long recordsPerPage)

Method Summary

void	applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query) Apply this function to a Request.
java.lang.String[]	getColumns()
java.util.List<java.lang.reflect.Method>	getGetters() Return the list of property getters on this function.
int	getNumBulkRecords()
long	getOffset()
long	getRecordsPerPage()
java.util.List<java.lang.reflect.Method>	getSetters() Return the list of property setters on this function.
void	setColumns(java.lang.String columns)
void	setColumns(java.lang.String[] columns)
void	setNumBulkRecords(int numBulkRecords) Defaults to 0.
void	setNumBulkRecords(java.lang.String numBulkRecords)
void	setOffset(long offset)
void	setOffset(java.lang.String offset)
void	setRecordsPerPage(long recordsPerPage)
void	setRecordsPerPage(java.lang.String recordsPerPage)
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 com.endeca.portal.data.functions.QueryConfig

getId, setId

Methods inherited from class com.endeca.portal.data.functions.QueryFunction

clone, equals, equals, getInstance, getInstance, getName, hashCode, init, setName, toJSON

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

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

Constructor Detail

ResultsConfig

public ResultsConfig()

ResultsConfig

public ResultsConfig(long recordsPerPage)

ResultsConfig

public ResultsConfig(java.lang.String id)

ResultsConfig

public ResultsConfig(java.lang.String id,
                     long recordsPerPage)

Method Detail

getRecordsPerPage

public long getRecordsPerPage()

setRecordsPerPage

public void setRecordsPerPage(long recordsPerPage)

setRecordsPerPage

public void setRecordsPerPage(java.lang.String recordsPerPage)
                       throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getNumBulkRecords

public int getNumBulkRecords()

setNumBulkRecords

public void setNumBulkRecords(int numBulkRecords)

Defaults to 0. This property only has an impact on Presentation API Connections.

Parameters:

bulkRecordsPerPage - the amount to set.

setNumBulkRecords

public void setNumBulkRecords(java.lang.String numBulkRecords)
                       throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getOffset

public long getOffset()

setOffset

public void setOffset(long offset)

setOffset

public void setOffset(java.lang.String offset)
               throws java.lang.NumberFormatException

Throws:

java.lang.NumberFormatException

getColumns

public java.lang.String[] getColumns()

setColumns

public void setColumns(java.lang.String[] columns)

setColumns

public void setColumns(java.lang.String columns)

getSetters

public java.util.List<java.lang.reflect.Method> getSetters()

Description copied from class: QueryFunction

Return the list of property setters on this function. Must be implemented by subclass. Required for correct JSON serialization/deserialization support. For most subclasses, implementing this method should be simple, as long as your setter methods follow standard Java naming conventions (e.g. "setPropertyName(PropertyType)"). All you should need to write is:

 private static List setters = Reflection.getSetters(MyFunctionClass.class);
 \@Override
 public List getSetters() {
        return setters;
 }
 

Specified by:

getSetters in class QueryFunction

Returns:

the list of setters

getGetters

public java.util.List<java.lang.reflect.Method> getGetters()

Description copied from class: QueryFunction

Return the list of property getters on this function. Must be implemented by subclass. Required for correct JSON serialization/deserialization support. For most subclasses, implementing this method should be simple, as long as your getter methods follow standard Java naming conventions (e.g. "getPropertyName()"). All you should need to write is:

 private static List getters = Reflection.getGetters(MyFunctionClass.class);
 \@Override
 public List getGetters() {
        return getters;
 }
 

Specified by:

getGetters in class QueryFunction

Returns:

the list of getters

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