com.inductiveautomation.ignition.common.browsing

Class BrowseResults

java.lang.Object

com.inductiveautomation.ignition.common.browsing.BrowseResults

All Implemented Interfaces:

java.io.Serializable

public class BrowseResults
extends java.lang.Object
implements java.io.Serializable

The results of a browse operation. May only represent a partial result set, which can be determined by comparing the Total Available Size to the Returned Size. If there is a mismatch, the continuation point should be non-null and can be used in constructing the subsequent BrowseFilter to continue the browse.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BrowseResults()
BrowseResults(java.util.Collection<Result> results)
BrowseResults(Quality failureQuality)

Method Summary

Modifier and Type	Method and Description
java.lang.Object	getContinuationPoint() A system specific object that can be used to continue the browse.
Quality	getResultQuality()
java.util.Collection<Result>	getResults() The results of the browse operation.
int	getReturnedSize() The number of results contained in this object.
int	getTotalAvailableSize() An estimation of the total number of results that would match this browse.
void	setContinuationPoint(java.lang.Object continuationPoint)
void	setResults(java.util.Collection<Result> results)
void	setTotalAvailableResults(int totalAvailableResults)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrowseResults

public BrowseResults()

BrowseResults

public BrowseResults(java.util.Collection<Result> results)

BrowseResults

public BrowseResults(Quality failureQuality)

Method Detail

getResults

public java.util.Collection<Result> getResults()

The results of the browse operation.

Returns:

getTotalAvailableSize

public int getTotalAvailableSize()

An estimation of the total number of results that would match this browse.

Returns:

getReturnedSize

public int getReturnedSize()

The number of results contained in this object. If different than getTotalAvailableSize(), only a partial browse was performed, and the continuation point should be non-null.

Returns:

getContinuationPoint

public java.lang.Object getContinuationPoint()

A system specific object that can be used to continue the browse. Null if the browse is complete, or the system does not support browse continuation.

Returns:

setResults

public void setResults(java.util.Collection<Result> results)

setTotalAvailableResults

public void setTotalAvailableResults(int totalAvailableResults)

setContinuationPoint

public void setContinuationPoint(java.lang.Object continuationPoint)

getResultQuality

public Quality getResultQuality()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object