com.endeca.portal.data.functions
Class ResultsConfig

java.lang.Object
  extended by com.endeca.portal.data.functions.QueryFunction
      extended by com.endeca.portal.data.functions.QueryConfig
          extended by 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 int DEFAULT_NUM_BULK_RECORDS
           
static long DEFAULT_OFFSET
           
static long DEFAULT_RECORDS_PER_PAGE
           
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(long offset, long recordsPerPage, int numBulkRecords, java.lang.String[] columns)
           
ResultsConfig(java.lang.String id)
           
ResultsConfig(java.lang.String id, long recordsPerPage)
           
ResultsConfig(java.lang.String id, long offset, long recordsPerPage, int numBulkRecords, java.lang.String[] columns)
           
 
Method Summary
 void applyToDiscoveryServiceQuery(com.endeca.mdex.conversation.Request query)
          Apply this function to a Request.
 java.lang.String[] getColumns()
           
 int getNumBulkRecords()
           
 long getOffset()
           
 long getRecordsPerPage()
           
 void setColumns(java.lang.String[] columns)
           
 void setNumBulkRecords(int numBulkRecords)
          Defaults to 0.
 void setOffset(long offset)
           
 void setRecordsPerPage(long 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
beforeQueryStateAdd, clone, equals, equals, getName, hashCode, initializeFromJSON, setName
 
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

DEFAULT_RECORDS_PER_PAGE

public static final long DEFAULT_RECORDS_PER_PAGE
See Also:
Constant Field Values

DEFAULT_NUM_BULK_RECORDS

public static final int DEFAULT_NUM_BULK_RECORDS
See Also:
Constant Field Values

DEFAULT_OFFSET

public static final long DEFAULT_OFFSET
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)

ResultsConfig

public ResultsConfig(long offset,
                     long recordsPerPage,
                     int numBulkRecords,
                     java.lang.String[] columns)

ResultsConfig

public ResultsConfig(java.lang.String id,
                     long offset,
                     long recordsPerPage,
                     int numBulkRecords,
                     java.lang.String[] columns)
Method Detail

getRecordsPerPage

public long getRecordsPerPage()

setRecordsPerPage

public void setRecordsPerPage(long recordsPerPage)

getNumBulkRecords

public int getNumBulkRecords()

setNumBulkRecords

public void setNumBulkRecords(int numBulkRecords)
Defaults to 0. This property only has an impact on Presentation API Connections.

Parameters:
numBulkRecords - the amount to set.

getOffset

public long getOffset()

setOffset

public void setOffset(long offset)

getColumns

public java.lang.String[] getColumns()

setColumns

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

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