Package stroom.query.api.v2

Class ResultRequest

java.lang.Object

stroom.query.api.v2.ResultRequest

All Implemented Interfaces:

java.io.Serializable

public final class ResultRequest
extends java.lang.Object
implements java.io.Serializable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResultRequest.Builder	Builder for constructing a ResultRequest
static class	ResultRequest.Fetch
static class	ResultRequest.ResultStyle

Constructor Summary

Constructors

Constructor	Description
ResultRequest()
ResultRequest(java.lang.String componentId)
ResultRequest(java.lang.String componentId, java.util.List<TableSettings> mappings, OffsetRange requestedRange)
ResultRequest(java.lang.String componentId, java.util.List<TableSettings> mappings, OffsetRange requestedRange, java.util.List<java.lang.String> openGroups, ResultRequest.ResultStyle resultStyle, ResultRequest.Fetch fetch)
ResultRequest(java.lang.String componentId, TableSettings mappings)
ResultRequest(java.lang.String componentId, TableSettings mappings, OffsetRange requestedRange)

Method Summary

Modifier and Type	Method	Description
boolean	equals(java.lang.Object o)
java.lang.String	getComponentId()
ResultRequest.Fetch	getFetch()	The fetch type determines if the request actually wants data returned or if it only wants data if the data has changed since the last request was made.
java.util.List<TableSettings>	getMappings()
java.util.List<java.lang.String>	getOpenGroups()
OffsetRange	getRequestedRange()
ResultRequest.ResultStyle	getResultStyle()
int	hashCode()
void	setComponentId(java.lang.String componentId)
void	setFetch(ResultRequest.Fetch fetch)
void	setMappings(java.util.List<TableSettings> mappings)
void	setOpenGroups(java.util.List<java.lang.String> openGroups)
void	setRequestedRange(OffsetRange requestedRange)
void	setResultStyle(ResultRequest.ResultStyle resultStyle)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ResultRequest

public ResultRequest()

ResultRequest

public ResultRequest(java.lang.String componentId)

ResultRequest

public ResultRequest(java.lang.String componentId,
                     TableSettings mappings)

ResultRequest

public ResultRequest(java.lang.String componentId,
                     TableSettings mappings,
                     OffsetRange requestedRange)

ResultRequest

public ResultRequest(java.lang.String componentId,
                     java.util.List<TableSettings> mappings,
                     OffsetRange requestedRange)

ResultRequest

public ResultRequest(java.lang.String componentId,
                     java.util.List<TableSettings> mappings,
                     OffsetRange requestedRange,
                     java.util.List<java.lang.String> openGroups,
                     ResultRequest.ResultStyle resultStyle,
                     ResultRequest.Fetch fetch)

Method Detail

getComponentId

public java.lang.String getComponentId()

setComponentId

public void setComponentId(java.lang.String componentId)

getMappings

public java.util.List<TableSettings> getMappings()

setMappings

public void setMappings(java.util.List<TableSettings> mappings)

getRequestedRange

public OffsetRange getRequestedRange()

setRequestedRange

public void setRequestedRange(OffsetRange requestedRange)

getOpenGroups

public java.util.List<java.lang.String> getOpenGroups()

setOpenGroups

public void setOpenGroups(java.util.List<java.lang.String> openGroups)

getResultStyle

public ResultRequest.ResultStyle getResultStyle()

setResultStyle

public void setResultStyle(ResultRequest.ResultStyle resultStyle)

getFetch

public ResultRequest.Fetch getFetch()

The fetch type determines if the request actually wants data returned or if it only wants data if the data has changed since the last request was made.

Returns:

The fetch type.

setFetch

public void setFetch(ResultRequest.Fetch fetch)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object