com.inductiveautomation.ignition.common.browsing

Class BasicResult

java.lang.Object

com.inductiveautomation.ignition.common.browsing.BasicResult

All Implemented Interfaces:

Result, java.io.Serializable

Direct Known Subclasses:

TagResult

public class BasicResult
extends java.lang.Object
implements Result

A basic implementation of Result that can be used for browsing operations.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BasicResult()
BasicResult(QualifiedPath path, boolean hasChildren)
BasicResult(Result copy)

Method Summary

Modifier and Type	Method and Description
Path	getDisplayPath() Returns the friendlier "display path" for this result.
QualifiedPath	getPath() Returns the qualified path of this result.
java.lang.String	getType() If the type is specifically defined, it is returned.
boolean	hasChildren() Indicates that this result object is itself browsable.
void	setDisplayPath(Path displayPath)
void	setHasChildren(boolean hasChildren)
void	setPath(QualifiedPath path)
void	setType(java.lang.String type)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicResult

public BasicResult()

BasicResult

public BasicResult(Result copy)

BasicResult

public BasicResult(QualifiedPath path,
                   boolean hasChildren)

Method Detail

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 java.lang.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

setType

public void setType(java.lang.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)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object