org.eclipse.milo.opcua.sdk.client.model.types.objects

Interface AuditWriteUpdateEventType

All Superinterfaces:

AuditEventType, AuditUpdateEventType, BaseEventType, BaseObjectType, Node, ObjectNode

All Known Implementing Classes:

AuditWriteUpdateEventTypeNode

public interface AuditWriteUpdateEventType
extends AuditUpdateEventType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	ATTRIBUTE_ID
static QualifiedProperty<String>	INDEX_RANGE
static QualifiedProperty<Object>	NEW_VALUE
static QualifiedProperty<Object>	OLD_VALUE

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.AuditEventType

ACTION_TIME_STAMP, CLIENT_AUDIT_ENTRY_ID, CLIENT_USER_ID, SERVER_ID, STATUS

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.BaseEventType

EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME

Method Summary

Modifier and Type	Method and Description
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	getAttributeId() Get the local value of the AttributeId Node.
PropertyType	getAttributeIdNode() Get the AttributeId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getAttributeIdNodeAsync() Asynchronous implementation of getAttributeIdNode().
String	getIndexRange() Get the local value of the IndexRange Node.
PropertyType	getIndexRangeNode() Get the IndexRange PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getIndexRangeNodeAsync() Asynchronous implementation of getIndexRangeNode().
Object	getNewValue() Get the local value of the NewValue Node.
PropertyType	getNewValueNode() Get the NewValue PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getNewValueNodeAsync() Asynchronous implementation of getNewValueNode().
Object	getOldValue() Get the local value of the OldValue Node.
PropertyType	getOldValueNode() Get the OldValue PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getOldValueNodeAsync() Asynchronous implementation of getOldValueNode().
org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger	readAttributeId() Read the value of the AttributeId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger>	readAttributeIdAsync() An asynchronous implementation of readAttributeId().
String	readIndexRange() Read the value of the IndexRange Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends String>	readIndexRangeAsync() An asynchronous implementation of readIndexRange().
Object	readNewValue() Read the value of the NewValue Node from the server and update the local value if the operation succeeds.
CompletableFuture<?>	readNewValueAsync() An asynchronous implementation of readNewValue().
Object	readOldValue() Read the value of the OldValue Node from the server and update the local value if the operation succeeds.
CompletableFuture<?>	readOldValueAsync() An asynchronous implementation of readOldValue().
void	setAttributeId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger attributeId) Set the local value of the AttributeId Node.
void	setIndexRange(String indexRange) Set the local value of the IndexRange Node.
void	setNewValue(Object newValue) Set the local value of the NewValue Node.
void	setOldValue(Object oldValue) Set the local value of the OldValue Node.
void	writeAttributeId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger attributeId) Write a new value for the AttributeId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeAttributeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger attributeId) An asynchronous implementation of writeAttributeId(UInteger).
void	writeIndexRange(String indexRange) Write a new value for the IndexRange Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeIndexRangeAsync(String indexRange) An asynchronous implementation of writeIndexRange(String).
void	writeNewValue(Object newValue) Write a new value for the NewValue Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeNewValueAsync(Object newValue) An asynchronous implementation of writeNewValue(Object).
void	writeOldValue(Object oldValue) Write a new value for the OldValue Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeOldValueAsync(Object oldValue) An asynchronous implementation of writeOldValue(Object).

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.AuditEventType

getActionTimeStamp, getActionTimeStampNode, getActionTimeStampNodeAsync, getClientAuditEntryId, getClientAuditEntryIdNode, getClientAuditEntryIdNodeAsync, getClientUserId, getClientUserIdNode, getClientUserIdNodeAsync, getServerId, getServerIdNode, getServerIdNodeAsync, getStatus, getStatusNode, getStatusNodeAsync, readActionTimeStamp, readActionTimeStampAsync, readClientAuditEntryId, readClientAuditEntryIdAsync, readClientUserId, readClientUserIdAsync, readServerId, readServerIdAsync, readStatus, readStatusAsync, setActionTimeStamp, setClientAuditEntryId, setClientUserId, setServerId, setStatus, writeActionTimeStamp, writeActionTimeStampAsync, writeClientAuditEntryId, writeClientAuditEntryIdAsync, writeClientUserId, writeClientUserIdAsync, writeServerId, writeServerIdAsync, writeStatus, writeStatusAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.types.objects.BaseEventType

getEventId, getEventIdNode, getEventIdNodeAsync, getEventType, getEventTypeNode, getEventTypeNodeAsync, getLocalTime, getLocalTimeNode, getLocalTimeNodeAsync, getMessage, getMessageNode, getMessageNodeAsync, getReceiveTime, getReceiveTimeNode, getReceiveTimeNodeAsync, getSeverity, getSeverityNode, getSeverityNodeAsync, getSourceName, getSourceNameNode, getSourceNameNodeAsync, getSourceNode, getSourceNodeNode, getSourceNodeNodeAsync, getTime, getTimeNode, getTimeNodeAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeEventId, writeEventIdAsync, writeEventType, writeEventTypeAsync, writeLocalTime, writeLocalTimeAsync, writeMessage, writeMessageAsync, writeReceiveTime, writeReceiveTimeAsync, writeSeverity, writeSeverityAsync, writeSourceName, writeSourceNameAsync, writeSourceNode, writeSourceNodeAsync, writeTime, writeTimeAsync

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

getEventNotifier, setEventNotifier

Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getUserWriteMask, getWriteMask, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setUserWriteMask, setWriteMask

Field Detail

ATTRIBUTE_ID

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> ATTRIBUTE_ID

INDEX_RANGE

static final QualifiedProperty<String> INDEX_RANGE

OLD_VALUE

static final QualifiedProperty<Object> OLD_VALUE

NEW_VALUE

static final QualifiedProperty<Object> NEW_VALUE

Method Detail

getAttributeId

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger getAttributeId()
                                                                          throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the AttributeId Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the AttributeId Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the AttributeId Node.

setAttributeId

void setAttributeId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger attributeId)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the AttributeId Node.

The value is only updated locally; it is not written to the server.

Parameters:

attributeId - the local value to set for the AttributeId Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the AttributeId Node.

readAttributeId

org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger readAttributeId()
                                                                           throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the AttributeId Node from the server and update the local value if the operation succeeds.

Returns:

the UInteger value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeAttributeId

void writeAttributeId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger attributeId)
               throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the AttributeId Node to the server and update the local value if the operation succeeds.

Parameters:

attributeId - the UInteger value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readAttributeIdAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger> readAttributeIdAsync()

An asynchronous implementation of readAttributeId().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeAttributeIdAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeAttributeIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UInteger attributeId)

An asynchronous implementation of writeAttributeId(UInteger).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getAttributeIdNode

PropertyType getAttributeIdNode()
                         throws org.eclipse.milo.opcua.stack.core.UaException

Get the AttributeId PropertyType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the AttributeId PropertyType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getAttributeIdNodeAsync

CompletableFuture<? extends PropertyType> getAttributeIdNodeAsync()

Asynchronous implementation of getAttributeIdNode().

Returns:

a CompletableFuture that completes successfully with the ? extends PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

getIndexRange

String getIndexRange()
              throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the IndexRange Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the IndexRange Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the IndexRange Node.

setIndexRange

void setIndexRange(String indexRange)
            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the IndexRange Node.

The value is only updated locally; it is not written to the server.

Parameters:

indexRange - the local value to set for the IndexRange Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the IndexRange Node.

readIndexRange

String readIndexRange()
               throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the IndexRange Node from the server and update the local value if the operation succeeds.

Returns:

the String value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeIndexRange

void writeIndexRange(String indexRange)
              throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the IndexRange Node to the server and update the local value if the operation succeeds.

Parameters:

indexRange - the String value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readIndexRangeAsync

CompletableFuture<? extends String> readIndexRangeAsync()

An asynchronous implementation of readIndexRange().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeIndexRangeAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeIndexRangeAsync(String indexRange)

An asynchronous implementation of writeIndexRange(String).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getIndexRangeNode

PropertyType getIndexRangeNode()
                        throws org.eclipse.milo.opcua.stack.core.UaException

Get the IndexRange PropertyType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the IndexRange PropertyType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getIndexRangeNodeAsync

CompletableFuture<? extends PropertyType> getIndexRangeNodeAsync()

Asynchronous implementation of getIndexRangeNode().

Returns:

a CompletableFuture that completes successfully with the ? extends PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

getOldValue

Object getOldValue()
            throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the OldValue Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the OldValue Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the OldValue Node.

setOldValue

void setOldValue(Object oldValue)
          throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the OldValue Node.

The value is only updated locally; it is not written to the server.

Parameters:

oldValue - the local value to set for the OldValue Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the OldValue Node.

readOldValue

Object readOldValue()
             throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the OldValue Node from the server and update the local value if the operation succeeds.

Returns:

the Object value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeOldValue

void writeOldValue(Object oldValue)
            throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the OldValue Node to the server and update the local value if the operation succeeds.

Parameters:

oldValue - the Object value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readOldValueAsync

CompletableFuture<?> readOldValueAsync()

An asynchronous implementation of readOldValue().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeOldValueAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeOldValueAsync(Object oldValue)

An asynchronous implementation of writeOldValue(Object).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getOldValueNode

PropertyType getOldValueNode()
                      throws org.eclipse.milo.opcua.stack.core.UaException

Get the OldValue PropertyType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the OldValue PropertyType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getOldValueNodeAsync

CompletableFuture<? extends PropertyType> getOldValueNodeAsync()

Asynchronous implementation of getOldValueNode().

Returns:

a CompletableFuture that completes successfully with the ? extends PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

getNewValue

Object getNewValue()
            throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the NewValue Node.

The returned value is the last seen; it is not read live from the server.

Returns:

the local value of the NewValue Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the NewValue Node.

setNewValue

void setNewValue(Object newValue)
          throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the NewValue Node.

The value is only updated locally; it is not written to the server.

Parameters:

newValue - the local value to set for the NewValue Node.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the NewValue Node.

readNewValue

Object readNewValue()
             throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the NewValue Node from the server and update the local value if the operation succeeds.

Returns:

the Object value read from the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

writeNewValue

void writeNewValue(Object newValue)
            throws org.eclipse.milo.opcua.stack.core.UaException

Write a new value for the NewValue Node to the server and update the local value if the operation succeeds.

Parameters:

newValue - the Object value to write to the server.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

readNewValueAsync

CompletableFuture<?> readNewValueAsync()

An asynchronous implementation of readNewValue().

Returns:

a CompletableFuture that completes successfully with the property value or completes exceptionally if an operation- or service-level error occurs.

writeNewValueAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeNewValueAsync(Object newValue)

An asynchronous implementation of writeNewValue(Object).

Returns:

a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

getNewValueNode

PropertyType getNewValueNode()
                      throws org.eclipse.milo.opcua.stack.core.UaException

Get the NewValue PropertyType Node, or null if it does not exist.

The Node is created when first accessed and cached for subsequent calls.

Returns:

the NewValue PropertyType Node, or null if it does not exist.

Throws:

org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

getNewValueNodeAsync

CompletableFuture<? extends PropertyType> getNewValueNodeAsync()

Asynchronous implementation of getNewValueNode().

Returns:

a CompletableFuture that completes successfully with the ? extends PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.