com.prosysopc.ua.nodes

Interface UaMethod

All Superinterfaces:

UaNode

All Known Implementing Classes:

PlainMethod, UaMethodImpl, UaMethodNode

public interface UaMethod
extends UaNode

Interface definition of OPC UA Method nodes.

Methods define callable functions. Methods are invoked using the Call Service. Method invocations are not represented in the AddressSpace. Method invocations always run to completion and always return responses when complete. Methods are defined using the Method NodeClass.

(OPC UA Specification, Part 3.)

Nested Class Summary

Nested classes/interfaces inherited from interface com.prosysopc.ua.nodes.UaNode

UaNode.Parameters

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedName	INPUT_ARGUMENTS The BrowseName of the InputArguments Property of a Method Node.
static QualifiedName	OUTPUT_ARGUMENTS The BrowseName of the OutputArguments Property of a Method Node.

Method Summary

Modifier and Type	Method and Description
Boolean	getExecutable() The Executable Attribute indicates if the Method is currently executable ('False' means not executable, 'True' means executable).
Argument[]	getInputArguments() The InputArguments Property is used to specify the arguments that shall be used by a client when calling the Method.
Argument[]	getOutputArguments() The OutputArguments Property specifies the result returned from the Method call.
Boolean	getUserExecutable() The UserExecutable Attribute indicates if the Method is currently executable taking user access rights into account ('False' means not executable, 'True' means executable).
void	setExecutable(Boolean executable)
void	setUserExecutable(Boolean userExecutable)

Methods inherited from interface com.prosysopc.ua.nodes.UaNode

addComponent, addOrganizes, addProperty, addReference, addReference, addReference, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getAttributesMap, getBrowseName, getBrowsePaths, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersionNode, getOrganizedNode, getOrganizedNodes, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUaBrowsePaths, getUaNodeId, getUserData, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserData, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute

Field Detail

INPUT_ARGUMENTS

static final QualifiedName INPUT_ARGUMENTS

The BrowseName of the InputArguments Property of a Method Node.

OUTPUT_ARGUMENTS

static final QualifiedName OUTPUT_ARGUMENTS

The BrowseName of the OutputArguments Property of a Method Node.

Method Detail

getExecutable

Boolean getExecutable()

The Executable Attribute indicates if the Method is currently executable ('False' means not executable, 'True' means executable). The Executable Attribute does not take any user access rights into account, i.e. although the Method is executable this may be restricted to a certain user / user group.

Returns:

the current value of executable.

getInputArguments

Argument[] getInputArguments()
                      throws MethodArgumentException

The InputArguments Property is used to specify the arguments that shall be used by a client when calling the Method.

Returns:

the InputArguments of the method. Should provide an empty list, if no arguments are defined.

Throws:

MethodArgumentException - if the property does not contain valid argument values

getOutputArguments

Argument[] getOutputArguments()
                       throws MethodArgumentException

The OutputArguments Property specifies the result returned from the Method call.

Returns:

the OutputArguments of the method. Should provide an empty list, if no arguments are defined.

Throws:

MethodArgumentException - if the property does not contain valid argument values

getUserExecutable

Boolean getUserExecutable()

The UserExecutable Attribute indicates if the Method is currently executable taking user access rights into account ('False' means not executable, 'True' means executable).

Returns:

the current value of user executable.

setExecutable

void setExecutable(Boolean executable)

Parameters:

executable - value to set for executable

See Also:

getExecutable()

setUserExecutable

void setUserExecutable(Boolean userExecutable)

Parameters:

userExecutable - value to set for user executable

See Also:

getUserExecutable()