Package com.inductiveautomation.ignition.common.browsing

Class 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 Detail

      • Results

        public Results()

      • Results

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

      • Results

        public Results​(QualityCode failureQuality)

    • Method Detail

      • 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

        @Nullable
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​(@Nullable
                                 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

      • createWrapper

        public static <T extends org.python.core.PyObject> Results.PyWrapper<T> createWrapper​(Results<T> results)