com.prosyst.mprm.admin.devices

Interface Node

All Superinterfaces:

NodeOperations

All Known Subinterfaces:

DeviceGroup, DeviceNode

public interface Node
extends NodeOperations

Represents node of the devices tree hierarchy. This is a common super interface of DeviceGroup and DeviceNode interafces and is intended to unify their common methods.

See Also:

DeviceGroup, DeviceNode

Method Summary

Modifier and Type	Method and Description
void	addListener(NodeListener listener) Adds listener, which will be notified about changes occurred in this node and in its direct members (if this node is a device group).
int	countDevices(java.lang.String deviceType, java.lang.String filter, boolean wholeSubTree) Counts devices of given type, potentially filtered by some search criteria.
Enumerator	findControlUnits(java.lang.String type, java.lang.String finderId, java.lang.Object finderArgs, java.lang.String filter, boolean wholeSubTree) Returns ids of the control units with a given component type and satisfying a given finder method with the supplied argument(s).
Enumerator	getControlUnits(java.lang.String type, java.lang.String filter, boolean wholeSubTree) Lists control units.
Enumerator	getControlUnits(java.lang.String type, java.lang.String finderId, java.lang.Object finderArgs, java.lang.String filter, boolean states, java.lang.String[] stateInterface, boolean wholeSubTree, boolean retrieveExtendingTypes) Retrieves control units by various filtering and retrieving options.
Enumerator	getControlUnitStates(java.lang.String type, java.lang.String[] stateInterface, java.lang.String filter, boolean wholeSubTree) Lists control unit states.
java.util.Date	getCreateDate() Returns the node create date
java.lang.String	getDisplayName() Returns user-friendly name of this node.
InheritableProperty	getInheritableProperty(java.lang.String propertyName) This method has similar behavior as invoking getProperty(propertyName, true), but it returns not only the value of the property, but also information whether this property is associated with the node itself or is inherited from some of its parent nodes.
java.util.Dictionary	getNodeProperties() Returns all generic properties associated with this node.
java.lang.String	getNodeType() Returns the type of this Node object.
DeviceGroup	getParent() Returns the parent object of this tree object.
java.lang.String	getPath() Returns the full path of this node.
java.lang.Object	getProperty(java.lang.String propertyName, boolean searchInParents) Returns the value of a generic property with the supplied propertyName associated with this tree node.
java.lang.String	getRelativeName() Returns the relative path ot this node.
void	removeListener(NodeListener listener) Removes a listener.
void	setDisplayName(java.lang.String displayName) Changes the user-friendly name of this node.
void	setProperties(java.util.Dictionary props) Assigns generic properties contained in the props paramater with this node.
void	setProperty(java.lang.String propertyName, java.lang.Object propertyValue) Assigns a generic property with the supplied propertyName and propertyValue with this node.

Methods inherited from interface com.prosyst.mprm.admin.devices.NodeOperations

createControlUnits, destroyControlUnits, invokeAction, synchronizeStates

Method Detail

getPath

java.lang.String getPath()

Returns the full path of this node. The path is unique within the tree composed of groups and devices and also represents the node location in the tree. The path of the root node of the tree is 'ROOT'.

Returns:

full tree path of this node or 'ROOT' if this is root tree node.

getDisplayName

java.lang.String getDisplayName()

Returns user-friendly name of this node. It may or may not be the same as the relative name of the node. This depends on the node type (root, group or device).

Returns:

user-friendly name used for displaying purposes.

setDisplayName

void setDisplayName(java.lang.String displayName)
             throws ManagementException

Changes the user-friendly name of this node. It may be set as a relative name of the node. This depends on the node type (root, group or device).

Parameters:

displayName - new displayName of node.

Throws:

ManagementException - it is thrown if an error while updating the display name of the node occurs.

getParent

DeviceGroup getParent()
               throws ManagementException

Returns the parent object of this tree object.

Returns:

parent device group of this node. If this device group represents the root of the devices tree, null is returned.

Throws:

ManagementException - is thrown if a system error occurs.

getNodeProperties

java.util.Dictionary getNodeProperties()
                                throws ManagementException

Returns all generic properties associated with this node. This method returns only properties which are explicitly assigned to this node. The properties inherited from the parent nodes are not included in the result.

Returns:

the generic properties of the node as a Dictionary containing (name, value) pairs.

Throws:

ManagementException - is thrown if a system error occurs.

getProperty

java.lang.Object getProperty(java.lang.String propertyName,
                             boolean searchInParents)
                      throws ManagementException

Returns the value of a generic property with the supplied propertyName associated with this tree node. If the property is not present in the current node and searchInParents parameter is set to true then the parent nodes are recursively searched for the property and the method returns the first non-null value found. If the property does not present the method returns null.

Parameters:

propertyName - the name of the node property.

searchInParents - specifies whether the property should be searched only in this node or also in its parent nodes.

Returns:

the value of the property or null if there is no such property associated with this node and its parent nodes.

Throws:

ManagementException - is thrown if a system error occurs.

setProperty

void setProperty(java.lang.String propertyName,
                 java.lang.Object propertyValue)
          throws ManagementException

Assigns a generic property with the supplied propertyName and propertyValue with this node. Passing null as a property value removes the property from the set of generic node properties. Note that deleting a property using this method means that invoking getProperty(propertyName, true) shall return the default value (if there is such) associated with the closest node parent.

Parameters:

propertyName - the name of the node property.

propertyValue - the value of the property.

Throws:

ManagementException - is thrown if a system error occurs.

setProperties

void setProperties(java.util.Dictionary props)
            throws ManagementException

Assigns generic properties contained in the props paramater with this node.

Parameters:

props - the properties to be set.

Throws:

ManagementException - is thrown if a system error occurs.

getInheritableProperty

InheritableProperty getInheritableProperty(java.lang.String propertyName)
                                    throws java.lang.Exception

This method has similar behavior as invoking getProperty(propertyName, true), but it returns not only the value of the property, but also information whether this property is associated with the node itself or is inherited from some of its parent nodes. This information is encapsulated in a InheritableProperty instance.

Parameters:

propertyName - the name of the generic property.

Returns:

InheritableProperty instance for that property or null if there is no such property associated with this node and its parent nodes.

Throws:

java.lang.Exception - is thrown if a system error occurs.

addListener

void addListener(NodeListener listener)
          throws ManagementException

Adds listener, which will be notified about changes occurred in this node and in its direct members (if this node is a device group).

Parameters:

listener - the application defined listener being added.

Throws:

ManagementException - if a system error occurs.

removeListener

void removeListener(NodeListener listener)

Removes a listener.

Parameters:

listener - the application defined listener being removed.

getRelativeName

java.lang.String getRelativeName()

Returns the relative path ot this node. It is the last part of the full path of node. Node paths are constructed as sequence of all parrent relative names starting from the root separated by '/'.

Returns:

the relative path ot this node.

getNodeType

java.lang.String getNodeType()

Returns the type of this Node object. Node type is as follow:

• If the node is a DeviceGroup its type is null.
• If the node is a DeviceNode its type the control unit type itself.

Returns:

The node type

getControlUnits

Enumerator getControlUnits(java.lang.String type,
                           java.lang.String filter,
                           boolean wholeSubTree)
                    throws ManagementException

Lists control units.

Parameters:

type - type of control units to be retrieved

filter - control units search filter in mPRM script syntax

wholeSubTree - if true then the method will search in the whole subtree, otherwise only direct mprm tree descendants will be evaluated for criteria compliance.

Returns:

Enumerator of ControlUnitID objects

Throws:

ManagementException

countDevices

int countDevices(java.lang.String deviceType,
                 java.lang.String filter,
                 boolean wholeSubTree)
          throws ManagementException

Counts devices of given type, potentially filtered by some search criteria.

Parameters:

deviceType - type of device root control units to be counted.

filter - control units search filter in mPRM script syntax.

wholeSubTree - if true then the method will search in the whole subtree, otherwise only direct mprm tree descendants will be evaluated for criteria compliance.

Returns:

Enumerator of ControlUnitID objects

Throws:

ManagementException

getControlUnitStates

Enumerator getControlUnitStates(java.lang.String type,
                                java.lang.String[] stateInterface,
                                java.lang.String filter,
                                boolean wholeSubTree)
                         throws ManagementException

Lists control unit states.

Parameters:

type - type of control units to be retrieved

stateInterface - state interface of control units to be retrieved

filter - control units search filter in mPRM script syntax

wholeSubTree - if true then the method will search in the whole subtree, otherwise only direct mprm tree descendants will be evaluated for criteria compliance.

Returns:

Enumerator of DeviceControlUnit objects

Throws:

ManagementException

findControlUnits

Enumerator findControlUnits(java.lang.String type,
                            java.lang.String finderId,
                            java.lang.Object finderArgs,
                            java.lang.String filter,
                            boolean wholeSubTree)
                     throws ManagementException

Returns ids of the control units with a given component type and satisfying a given finder method with the supplied argument(s). Note that finder methods are supported for component units only. If there are different versions of this control unit type provided, the finder action will be invoked only on control units with versions that provide this finder with this interface. If there is no version providing the invoked finder - exception will be thrown to indicate wrong arguments.

Parameters:

type - type of control units to be retrieved

finderId - the id of the finder method. Must start with "$find.".

finderArgs - the finder argument(s). If the argument is only one this is the argument itself. If the arguments are more then one, the value must be a Object[] and arguments are retrieved from that array.

filter - control units search filter in mPRM script syntax. The control units returned by the finder argument will be secondary filtered by the supplied filter.

wholeSubTree - if true then the method will search in the whole subtree, otherwise only direct mprm tree descendants will be evaluated for criteria compliance.

Returns:

Enumerator of ControlUnitID objects

Throws:

ManagementException - if a system error occurs.

getControlUnits

Enumerator getControlUnits(java.lang.String type,
                           java.lang.String finderId,
                           java.lang.Object finderArgs,
                           java.lang.String filter,
                           boolean states,
                           java.lang.String[] stateInterface,
                           boolean wholeSubTree,
                           boolean retrieveExtendingTypes)
                    throws ManagementException

Retrieves control units by various filtering and retrieving options.

Parameters:

type - control unit type.

finderId - id of finder action. Value of null should be specified if searching is not by finder action.

finderArgs - arguments of the finder action specified by finderId. Value of null should be specified if searching is not by finder action.

filter - control unit filter in mPRM Script lexical syntax.

states - boolean flag specifying whether the result Enumerator to retrieve states (valid of true) or just control unit ids (value of false).

stateInterface - in combination with value of true for the states arguments, this argument may specify a list of state variables defining sub-state of the control unit states to be retieved. Value of null will retrieve the whole control unit states.

wholeSubTree - if true then the method will search in the whole subtree, otherwise only direct mprm tree descendants will be evaluated for criteria compliance.

retrieveExtendingTypes - if true, the method will retrieve the control units of the specified type as well as the control units of its extending types. Value of false will not return the control units of the extending types. Default behavior is when listing control unit of given type - to retrieve the control units of the extension types, too.

Returns:

if true is passed as value of the states parameter, the result is Enumerator of DeviceControlUnit object, otherwise the result is Enumerator if ControlUnitID objects.

Throws:

ManagementException - if system error occurs.

getCreateDate

java.util.Date getCreateDate()

Returns the node create date

Returns:

the date the node was created