Package com.inductiveautomation.ignition.common.browsing

Class BasicResult

java.lang.Object
com.inductiveautomation.ignition.common.browsing.BasicResult
All Implemented Interfaces:
Result, Serializable
Direct Known Subclasses:
TagResult
public class BasicResult extends Object implements Result
A basic implementation of Result that can be used for browsing operations.
See Also:

  • Constructor Details

    • BasicResult

      public BasicResult()

    • BasicResult

      public BasicResult(Result copy)

    • BasicResult

      public BasicResult(QualifiedPath path, boolean hasChildren)

  • Method Details

    • getDisplayPath

      public Path getDisplayPath()
      Description copied from interface: Result
      Returns the friendlier "display path" for this result. May be null, and not necessarily unique.
      Specified by:
      getDisplayPath in interface Result

    • setDisplayPath

      public void setDisplayPath(Path displayPath)

    • getPath

      public QualifiedPath getPath()
      Description copied from interface: Result
      Returns the qualified path of this result.
      Specified by:
      getPath in interface Result

    • setPath

      public void setPath(QualifiedPath path)

    • getType

      public String getType()
      If the type is specifically defined, it is returned. Otherwise, the last path component id is returned.
      Specified by:
      getType in interface Result

    • getExplicitType

      public @Nullable String getExplicitType()

    • setType

      public void setType(String type)

    • hasChildren

      public boolean hasChildren()
      Description copied from interface: Result
      Indicates that this result object is itself browsable.
      Specified by:
      hasChildren in interface Result

    • setHasChildren

      public void setHasChildren(boolean hasChildren)

    • getMetadata

      public PropertySet getMetadata()
      Specified by:
      getMetadata in interface Result

    • setMetadata

      public void setMetadata(@Nullable PropertySet metadata)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object