com.inductiveautomation.xopc.driver.api

Interface BrowseOperation

All Known Implementing Classes:

BrowseOperationIntercept

public interface BrowseOperation

Method Summary

Modifier and Type	Method and Description
void	browseDone(StatusCode status, java.util.List<java.lang.String> children, Guid guid) Callback for when the browsing finishes.
java.lang.String	getStartingAddress() Returns the address of a folder or object to start the browse at.

Method Detail

getStartingAddress

java.lang.String getStartingAddress()

Returns the address of a folder or object to start the browse at. A null or empty String indicates to browse from the root.

browseDone

void browseDone(StatusCode status,
                java.util.List<java.lang.String> children,
                Guid guid)

Callback for when the browsing finishes. If the status code is not good, then nodes should be null.

Parameters:

status - The status code for this browse. If the status is good, then nodes should be non-null, otherwise, nodes will be ignored.

children - Addresses of the child nodes under the starting address.

guid - A serial number for the address space of the driver being browsed. This should be incremented any time the browse structure is changed.