Results

java.lang.Object
- com.inductiveautomation.ignition.common.browsing.Results<T>

All Implemented Interfaces:

java.io.Serializable
```
public class Results<T>
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 Description

Results()

Results(QualityCode failureQuality)

Results(java.util.Collection<T> results)

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static <T> Results<T>`	`error(QualityCode result)`
`java.lang.String`	`getContinuationPoint()`	A system specific object that can be used to continue the browse.
`QualityCode`	`getResultQuality()`
`java.util.Collection<T>`	`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.
`static <T> Results<T>`	`of(java.util.Collection<T> results)`
`void`	`setContinuationPoint(java.lang.String continuationPoint)`
`void`	`setResultQuality(QualityCode value)`
`void`	`setResults(java.util.Collection<T> 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

Results
```
public Results()
```

Results

public Results(java.util.Collection<T> results)

Results

public Results(QualityCode failureQuality)

Method Detail
- error
```
public static <T> Results<T> error(QualityCode result)
```
- of
```
public static <T> Results<T> of(java.util.Collection<T> results)
```
- getResults
```
public java.util.Collection<T> getResults()
```
  The results of the browse operation.
- getTotalAvailableSize
```
public int getTotalAvailableSize()
```
  An estimation of the total number of results that would match this browse.
- 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.
- getContinuationPoint
```
public java.lang.String 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.
- setResults
```
public void setResults(java.util.Collection<T> results)
```
- setTotalAvailableResults
```
public void setTotalAvailableResults(int totalAvailableResults)
```
- setContinuationPoint
```
public void setContinuationPoint(java.lang.String continuationPoint)
```
- getResultQuality
```
public QualityCode getResultQuality()
```
- setResultQuality
```
public void setResultQuality(QualityCode value)
```
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object