Module com.aoindustries.noc.monitor.api

Package com.aoindustries.noc.monitor.common

Interface Node

All Superinterfaces:

Remote

All Known Subinterfaces:

RootNode, SingleResultNode, TableMultiResultNode<R>, TableResultNode

public interface Node
extends Remote

Author:

AO Industries, Inc.

Method Summary

Modifier and Type	Method	Description
AlertCategory	getAlertCategory()	Gets the alert category for this node.
AlertLevel	getAlertLevel()	Gets the current alert level for this node.
String	getAlertMessage()	Gets the current alert message or null for none.
boolean	getAllowsChildren()	Gets the flag indicating the node allows children.
List<? extends Node>	getChildren()	Gets an unmodifiable list of children of this node.
String	getLabel()	Gets the label for this node.
Node	getParent()	Gets the parent of this node or null if this is the root node.

Method Detail

getParent

Node getParent()
        throws RemoteException

Gets the parent of this node or null if this is the root node.

Throws:

RemoteException

getChildren

List<? extends Node> getChildren()
                          throws RemoteException

Gets an unmodifiable list of children of this node. The list returned is a snapshot copy of the node state; it will not be updated when the node children change and it may be used without any additional synchronization.

Throws:

RemoteException

getAlertLevel

AlertLevel getAlertLevel()
                  throws RemoteException

Gets the current alert level for this node.

Throws:

RemoteException

getAlertMessage

String getAlertMessage()
                throws RemoteException

Gets the current alert message or null for none.

Throws:

RemoteException

getAlertCategory

AlertCategory getAlertCategory()
                        throws RemoteException

Gets the alert category for this node.

Throws:

RemoteException

getAllowsChildren

boolean getAllowsChildren()
                   throws RemoteException

Gets the flag indicating the node allows children. This is primarily used as a hint for GUI interfaces to render the node correctly, but every node is expected to return true here if it will ever have any children.

Throws:

RemoteException

getLabel

String getLabel()
         throws RemoteException

Gets the label for this node. The label must be constant throughout the life of the node.

Throws:

RemoteException