Class Results<T>
java.lang.Object
com.inductiveautomation.ignition.common.browsing.Results<T>
- All Implemented Interfaces:
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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final class
Results.PyWrapper<T extends org.python.core.PyObject>
-
Constructor Summary
ConstructorsConstructorDescriptionResults()
Results
(QualityCode failureQuality) Results
(Collection<T> results) -
Method Summary
Modifier and TypeMethodDescriptionstatic <T extends org.python.core.PyObject>
Results.PyWrapper<T>createWrapper
(Results<T> results) static <T> Results<T>
error
(QualityCode result) A system specific object that can be used to continue the browse.The results of the browse operation.int
The number of results contained in this object.int
An estimation of the total number of results that would match this browse.static <T> Results<T>
of
(Collection<T> results) void
setContinuationPoint
(String continuationPoint) void
setResultQuality
(QualityCode value) void
setResults
(Collection<T> results) void
setTotalAvailableResults
(int totalAvailableResults) toString()
-
Constructor Details
-
Results
public Results() -
Results
-
Results
-
-
Method Details
-
error
-
of
-
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
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
-
setTotalAvailableResults
public void setTotalAvailableResults(int totalAvailableResults) -
setContinuationPoint
-
getResultQuality
-
setResultQuality
-
toString
-
createWrapper
public static <T extends org.python.core.PyObject> Results.PyWrapper<T> createWrapper(Results<T> results)
-