Module org.eclipse.milo.opcua.sdk.client

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

Interface AuditConditionCommentEventType

All Superinterfaces:

AuditConditionEventType, AuditEventType, AuditUpdateMethodEventType, BaseEventType, BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

All Known Implementing Classes:

AuditConditionCommentEventTypeNode

public interface AuditConditionCommentEventType
extends AuditConditionEventType

See Also:

• https://reference.opcfoundation.org/v105/Core/docs/Part9/5.10.4

Field Summary

Fields

Modifier and Type	Field	Description
static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	COMMENT
static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>	CONDITION_EVENT_ID

Fields inherited from interface org.eclipse.milo.opcua.sdk.client.model.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.objects.AuditUpdateMethodEventType

INPUT_ARGUMENTS, METHOD_ID, OUTPUT_ARGUMENTS, STATUS_CODE_ID

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

CONDITION_CLASS_ID, CONDITION_CLASS_NAME, CONDITION_SUB_CLASS_ID, CONDITION_SUB_CLASS_NAME, EVENT_ID, EVENT_TYPE, LOCAL_TIME, MESSAGE, RECEIVE_TIME, SEVERITY, SOURCE_NAME, SOURCE_NODE, TIME

Method Summary

Modifier and Type	Method	Description
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getComment()	Get the local value of the Comment Node.
PropertyType	getCommentNode()	Get the Comment PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getCommentNodeAsync()	Asynchronous implementation of getCommentNode().
org.eclipse.milo.opcua.stack.core.types.builtin.ByteString	getConditionEventId()	Get the local value of the ConditionEventId Node.
PropertyType	getConditionEventIdNode()	Get the ConditionEventId PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getConditionEventIdNodeAsync()	Asynchronous implementation of getConditionEventIdNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readComment()	Read the value of the Comment Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readCommentAsync()	An asynchronous implementation of readComment().
org.eclipse.milo.opcua.stack.core.types.builtin.ByteString	readConditionEventId()	Read the value of the ConditionEventId Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString>	readConditionEventIdAsync()	An asynchronous implementation of readConditionEventId().
void	setComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Set the local value of the Comment Node.
void	setConditionEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)	Set the local value of the ConditionEventId Node.
void	writeComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	Write a new value for the Comment Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCommentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)	An asynchronous implementation of writeComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).
void	writeConditionEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)	Write a new value for the ConditionEventId Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeConditionEventIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)	An asynchronous implementation of writeConditionEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString).

Methods inherited from interface org.eclipse.milo.opcua.sdk.client.model.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.objects.AuditUpdateMethodEventType

getInputArguments, getInputArgumentsNode, getInputArgumentsNodeAsync, getMethodId, getMethodIdNode, getMethodIdNodeAsync, getOutputArguments, getOutputArgumentsNode, getOutputArgumentsNodeAsync, getStatusCodeId, getStatusCodeIdNode, getStatusCodeIdNodeAsync, readInputArguments, readInputArgumentsAsync, readMethodId, readMethodIdAsync, readOutputArguments, readOutputArgumentsAsync, readStatusCodeId, readStatusCodeIdAsync, setInputArguments, setMethodId, setOutputArguments, setStatusCodeId, writeInputArguments, writeInputArgumentsAsync, writeMethodId, writeMethodIdAsync, writeOutputArguments, writeOutputArgumentsAsync, writeStatusCodeId, writeStatusCodeIdAsync

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

getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionSubClassId, getConditionSubClassIdNode, getConditionSubClassIdNodeAsync, getConditionSubClassName, getConditionSubClassNameNode, getConditionSubClassNameNodeAsync, 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, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionSubClassId, readConditionSubClassIdAsync, readConditionSubClassName, readConditionSubClassNameAsync, readEventId, readEventIdAsync, readEventType, readEventTypeAsync, readLocalTime, readLocalTimeAsync, readMessage, readMessageAsync, readReceiveTime, readReceiveTimeAsync, readSeverity, readSeverityAsync, readSourceName, readSourceNameAsync, readSourceNode, readSourceNodeAsync, readTime, readTimeAsync, setConditionClassId, setConditionClassName, setConditionSubClassId, setConditionSubClassName, setEventId, setEventType, setLocalTime, setMessage, setReceiveTime, setSeverity, setSourceName, setSourceNode, setTime, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionSubClassId, writeConditionSubClassIdAsync, writeConditionSubClassName, writeConditionSubClassNameAsync, 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.Node

getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

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

getEventNotifier, setEventNotifier

Field Details

CONDITION_EVENT_ID

static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> CONDITION_EVENT_ID

COMMENT

static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> COMMENT

Method Details

getConditionEventId

org.eclipse.milo.opcua.stack.core.types.builtin.ByteString getConditionEventId()
                                                                        throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ConditionEventId Node.

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

Returns:

the local value of the ConditionEventId Node.

Throws:

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

setConditionEventId

void setConditionEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)
                  throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ConditionEventId Node.

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

Parameters:

value - the local value to set for the ConditionEventId Node.

Throws:

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

readConditionEventId

org.eclipse.milo.opcua.stack.core.types.builtin.ByteString readConditionEventId()
                                                                         throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the ByteString value read from the server.

Throws:

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

writeConditionEventId

void writeConditionEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)
                    throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

value - the ByteString value to write to the server.

Throws:

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

readConditionEventIdAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.ByteString> readConditionEventIdAsync()

An asynchronous implementation of readConditionEventId().

Returns:

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

writeConditionEventIdAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeConditionEventIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString value)

An asynchronous implementation of writeConditionEventId(org.eclipse.milo.opcua.stack.core.types.builtin.ByteString).

Returns:

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

getConditionEventIdNode

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

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

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

Returns:

the ConditionEventId 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.

getConditionEventIdNodeAsync

CompletableFuture<? extends PropertyType> getConditionEventIdNodeAsync()

Asynchronous implementation of getConditionEventIdNode().

Returns:

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

getComment

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText getComment()
                                                                  throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the Comment Node.

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

Returns:

the local value of the Comment Node.

Throws:

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

setComment

void setComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
         throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Comment Node.

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

Parameters:

value - the local value to set for the Comment Node.

Throws:

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

readComment

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText readComment()
                                                                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the LocalizedText value read from the server.

Throws:

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

writeComment

void writeComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)
           throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

value - the LocalizedText value to write to the server.

Throws:

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

readCommentAsync

CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText> readCommentAsync()

An asynchronous implementation of readComment().

Returns:

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

writeCommentAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCommentAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText value)

An asynchronous implementation of writeComment(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText).

Returns:

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

getCommentNode

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

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

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

Returns:

the Comment 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.

getCommentNodeAsync

CompletableFuture<? extends PropertyType> getCommentNodeAsync()

Asynchronous implementation of getCommentNode().

Returns:

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