com.sap.bpm.api

Class QueryResultParameters

java.lang.Object
  com.sap.bpm.api.QueryResultParameters

public final class QueryResultParameters
extends Object

Optional set of query parameters used within certain API methods which e.g. allow to set the index of the first result or the maximum number of results which are returned.

SAP API Classification:

This class is intended to be used only and may not be subclassed by client code.

Constructor Summary

QueryResultParameters()

QueryResultParameters(Integer firstResult, Integer maxResults)

Method Summary

Integer	getFirstResult() Returns the index (starting with 0) of the first result which may be fetched by the JDBC call.
Integer	getMaxResults() Returns the maximum number of results which shall be returned by the query.
void	setFirstResult(Integer startPosition) Sets the index (starting with 0) of the first result which may be fetched by the JDBC call.
void	setMaxResults(Integer maxResults) Sets the maximum number of results which shall be returned by the query.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryResultParameters

public QueryResultParameters()

QueryResultParameters

public QueryResultParameters(Integer firstResult,
                             Integer maxResults)

Method Detail

getFirstResult

public Integer getFirstResult()

Returns the index (starting with 0) of the first result which may be fetched by the JDBC call. May return null, which means that no start index shall be used

Returns:

the index of the first result or null

setFirstResult

public void setFirstResult(Integer startPosition)

Sets the index (starting with 0) of the first result which may be fetched by the JDBC call. May be null, which means that no start index shall be used

Parameters:

startPosition - The index of the first result or null

getMaxResults

public Integer getMaxResults()

Returns the maximum number of results which shall be returned by the query. May return null, which means the number of results shall not be limited

Returns:

The number of results which shall be returned or null in case the number of results is not limited

setMaxResults

public void setMaxResults(Integer maxResults)
                   throws IllegalArgumentException

Sets the maximum number of results which shall be returned by the query. May be null, which means the number of results shall not be limited

Parameters:

maxResults - The number of results which shall be returned or null in case the number of results is not limited

Throws:

IllegalArgumentException - in case of values < 1

toString

public String toString()

Overrides:

toString in class Object

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] BPEM-FACADE	[sap.com] tc/bpem/facade/ear	-	BC-BMT-BPM-DSK
[sap.com] BPEM-FACADE	[sap.com] tc/bpem/facade/ear	api	BC-BMT-BPM-DSK