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.)


Method Summary
 Boolean getExecutable()
          The Executable Attribute indicates if the Method is currently executable ('False' means not executable, 'True' means executable).
 org.opcfoundation.ua.core.Argument[] getInputArguments()
          The InputArguments Property is used to specify the arguments that shall be used by a client when calling the Method.
 org.opcfoundation.ua.core.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, addProperty, addReference, addReference, addReference, deleteReference, deleteReference, deleteReference, deleteReference, getAddressSpace, getAttributes, getBrowseName, getComponent, getComponents, getDescription, getDisplayName, getForwardReferences, getInverseReferences, getMethod, getNodeClass, getNodeId, getNodeVersion, getProperties, getProperty, getReference, getReferences, getReferences, getSupportedAttributes, getUserWriteMask, getWriteMask, hasUserWriteAccess, hasWriteAccess, readAttribute, readAttribute, removeComponent, removeProperty, setAttribute, setAttributes, setBrowseName, setDescription, setDisplayName, setReferences, setUserWriteMask, setWriteMask, supportsAttribute, writeAttribute
 

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

org.opcfoundation.ua.core.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

org.opcfoundation.ua.core.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()


Copyright © 2018. All rights reserved.