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

Interface DialogConditionType

All Superinterfaces:

BaseEventType, BaseObjectType, ConditionType, Node, ObjectNode

All Known Implementing Classes:

DialogConditionTypeNode

public interface DialogConditionType
extends ConditionType

Field Summary

Fields

Modifier and Type	Field and Description
static QualifiedProperty<Integer>	CANCEL_RESPONSE
static QualifiedProperty<Integer>	DEFAULT_RESPONSE
static QualifiedProperty<Integer>	LAST_RESPONSE
static QualifiedProperty<Integer>	OK_RESPONSE
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	PROMPT
static QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]>	RESPONSE_OPTION_SET

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

BRANCH_ID, CLIENT_USER_ID, CONDITION_CLASS_ID, CONDITION_CLASS_NAME, CONDITION_NAME, RETAIN

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
Integer	getCancelResponse() Get the local value of the CancelResponse Node.
PropertyType	getCancelResponseNode() Get the CancelResponse PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getCancelResponseNodeAsync() Asynchronous implementation of getCancelResponseNode().
Integer	getDefaultResponse() Get the local value of the DefaultResponse Node.
PropertyType	getDefaultResponseNode() Get the DefaultResponse PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getDefaultResponseNodeAsync() Asynchronous implementation of getDefaultResponseNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getDialogState() Get the local value of the DialogState Node.
TwoStateVariableType	getDialogStateNode() Get the DialogState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableType>	getDialogStateNodeAsync() Asynchronous implementation of getDialogStateNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getEnabledState() Get the local value of the EnabledState Node.
TwoStateVariableType	getEnabledStateNode() Get the EnabledState TwoStateVariableType Node, or null if it does not exist.
CompletableFuture<? extends TwoStateVariableType>	getEnabledStateNodeAsync() Asynchronous implementation of getEnabledStateNode().
Integer	getLastResponse() Get the local value of the LastResponse Node.
PropertyType	getLastResponseNode() Get the LastResponse PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getLastResponseNodeAsync() Asynchronous implementation of getLastResponseNode().
Integer	getOkResponse() Get the local value of the OkResponse Node.
PropertyType	getOkResponseNode() Get the OkResponse PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getOkResponseNodeAsync() Asynchronous implementation of getOkResponseNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	getPrompt() Get the local value of the Prompt Node.
PropertyType	getPromptNode() Get the Prompt PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getPromptNodeAsync() Asynchronous implementation of getPromptNode().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	getResponseOptionSet() Get the local value of the ResponseOptionSet Node.
PropertyType	getResponseOptionSetNode() Get the ResponseOptionSet PropertyType Node, or null if it does not exist.
CompletableFuture<? extends PropertyType>	getResponseOptionSetNodeAsync() Asynchronous implementation of getResponseOptionSetNode().
Integer	readCancelResponse() Read the value of the CancelResponse Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Integer>	readCancelResponseAsync() An asynchronous implementation of readCancelResponse().
Integer	readDefaultResponse() Read the value of the DefaultResponse Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Integer>	readDefaultResponseAsync() An asynchronous implementation of readDefaultResponse().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readDialogState() Read the value of the DialogState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readDialogStateAsync() An asynchronous implementation of readDialogState().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readEnabledState() Read the value of the EnabledState Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readEnabledStateAsync() An asynchronous implementation of readEnabledState().
Integer	readLastResponse() Read the value of the LastResponse Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Integer>	readLastResponseAsync() An asynchronous implementation of readLastResponse().
Integer	readOkResponse() Read the value of the OkResponse Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends Integer>	readOkResponseAsync() An asynchronous implementation of readOkResponse().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText	readPrompt() Read the value of the Prompt Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText>	readPromptAsync() An asynchronous implementation of readPrompt().
org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]	readResponseOptionSet() Read the value of the ResponseOptionSet Node from the server and update the local value if the operation succeeds.
CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]>	readResponseOptionSetAsync() An asynchronous implementation of readResponseOptionSet().
void	setCancelResponse(Integer cancelResponse) Set the local value of the CancelResponse Node.
void	setDefaultResponse(Integer defaultResponse) Set the local value of the DefaultResponse Node.
void	setDialogState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText dialogState) Set the local value of the DialogState Node.
void	setEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState) Set the local value of the EnabledState Node.
void	setLastResponse(Integer lastResponse) Set the local value of the LastResponse Node.
void	setOkResponse(Integer okResponse) Set the local value of the OkResponse Node.
void	setPrompt(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText prompt) Set the local value of the Prompt Node.
void	setResponseOptionSet(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] responseOptionSet) Set the local value of the ResponseOptionSet Node.
void	writeCancelResponse(Integer cancelResponse) Write a new value for the CancelResponse Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeCancelResponseAsync(Integer cancelResponse) An asynchronous implementation of writeCancelResponse(Integer).
void	writeDefaultResponse(Integer defaultResponse) Write a new value for the DefaultResponse Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDefaultResponseAsync(Integer defaultResponse) An asynchronous implementation of writeDefaultResponse(Integer).
void	writeDialogState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText dialogState) Write a new value for the DialogState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeDialogStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText dialogState) An asynchronous implementation of writeDialogState(LocalizedText).
void	writeEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState) Write a new value for the EnabledState Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeEnabledStateAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState) An asynchronous implementation of writeEnabledState(LocalizedText).
void	writeLastResponse(Integer lastResponse) Write a new value for the LastResponse Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeLastResponseAsync(Integer lastResponse) An asynchronous implementation of writeLastResponse(Integer).
void	writeOkResponse(Integer okResponse) Write a new value for the OkResponse Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeOkResponseAsync(Integer okResponse) An asynchronous implementation of writeOkResponse(Integer).
void	writePrompt(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText prompt) Write a new value for the Prompt Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writePromptAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText prompt) An asynchronous implementation of writePrompt(LocalizedText).
void	writeResponseOptionSet(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] responseOptionSet) Write a new value for the ResponseOptionSet Node to the server and update the local value if the operation succeeds.
CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>	writeResponseOptionSetAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] responseOptionSet) An asynchronous implementation of writeResponseOptionSet(LocalizedText[]).

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

getBranchId, getBranchIdNode, getBranchIdNodeAsync, getClientUserId, getClientUserIdNode, getClientUserIdNodeAsync, getComment, getCommentNode, getCommentNodeAsync, getConditionClassId, getConditionClassIdNode, getConditionClassIdNodeAsync, getConditionClassName, getConditionClassNameNode, getConditionClassNameNodeAsync, getConditionName, getConditionNameNode, getConditionNameNodeAsync, getLastSeverity, getLastSeverityNode, getLastSeverityNodeAsync, getQuality, getQualityNode, getQualityNodeAsync, getRetain, getRetainNode, getRetainNodeAsync, readBranchId, readBranchIdAsync, readClientUserId, readClientUserIdAsync, readComment, readCommentAsync, readConditionClassId, readConditionClassIdAsync, readConditionClassName, readConditionClassNameAsync, readConditionName, readConditionNameAsync, readLastSeverity, readLastSeverityAsync, readQuality, readQualityAsync, readRetain, readRetainAsync, setBranchId, setClientUserId, setComment, setConditionClassId, setConditionClassName, setConditionName, setLastSeverity, setQuality, setRetain, writeBranchId, writeBranchIdAsync, writeClientUserId, writeClientUserIdAsync, writeComment, writeCommentAsync, writeConditionClassId, writeConditionClassIdAsync, writeConditionClassName, writeConditionClassNameAsync, writeConditionName, writeConditionNameAsync, writeLastSeverity, writeLastSeverityAsync, writeQuality, writeQualityAsync, writeRetain, writeRetainAsync

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

PROMPT

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

RESPONSE_OPTION_SET

static final QualifiedProperty<org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]> RESPONSE_OPTION_SET

DEFAULT_RESPONSE

static final QualifiedProperty<Integer> DEFAULT_RESPONSE

OK_RESPONSE

static final QualifiedProperty<Integer> OK_RESPONSE

CANCEL_RESPONSE

static final QualifiedProperty<Integer> CANCEL_RESPONSE

LAST_RESPONSE

static final QualifiedProperty<Integer> LAST_RESPONSE

Method Detail

getPrompt

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

Get the local value of the Prompt Node.

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

Returns:

the local value of the Prompt Node.

Throws:

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

setPrompt

void setPrompt(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText prompt)
        throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the Prompt Node.

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

Parameters:

prompt - the local value to set for the Prompt Node.

Throws:

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

readPrompt

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

Read the value of the Prompt 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.

writePrompt

void writePrompt(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText prompt)
          throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

prompt - the LocalizedText value to write to the server.

Throws:

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

readPromptAsync

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

An asynchronous implementation of readPrompt().

Returns:

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

writePromptAsync

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

An asynchronous implementation of writePrompt(LocalizedText).

Returns:

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

getPromptNode

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

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

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

Returns:

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

getPromptNodeAsync

CompletableFuture<? extends PropertyType> getPromptNodeAsync()

Asynchronous implementation of getPromptNode().

Returns:

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

getResponseOptionSet

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] getResponseOptionSet()
                                                                              throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the ResponseOptionSet Node.

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

Returns:

the local value of the ResponseOptionSet Node.

Throws:

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

setResponseOptionSet

void setResponseOptionSet(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] responseOptionSet)
                   throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the ResponseOptionSet Node.

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

Parameters:

responseOptionSet - the local value to set for the ResponseOptionSet Node.

Throws:

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

readResponseOptionSet

org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] readResponseOptionSet()
                                                                               throws org.eclipse.milo.opcua.stack.core.UaException

Read the value of the ResponseOptionSet 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.

writeResponseOptionSet

void writeResponseOptionSet(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] responseOptionSet)
                     throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

responseOptionSet - the LocalizedText[] value to write to the server.

Throws:

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

readResponseOptionSetAsync

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

An asynchronous implementation of readResponseOptionSet().

Returns:

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

writeResponseOptionSetAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeResponseOptionSetAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] responseOptionSet)

An asynchronous implementation of writeResponseOptionSet(LocalizedText[]).

Returns:

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

getResponseOptionSetNode

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

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

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

Returns:

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

getResponseOptionSetNodeAsync

CompletableFuture<? extends PropertyType> getResponseOptionSetNodeAsync()

Asynchronous implementation of getResponseOptionSetNode().

Returns:

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

getDefaultResponse

Integer getDefaultResponse()
                    throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the DefaultResponse Node.

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

Returns:

the local value of the DefaultResponse Node.

Throws:

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

setDefaultResponse

void setDefaultResponse(Integer defaultResponse)
                 throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the DefaultResponse Node.

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

Parameters:

defaultResponse - the local value to set for the DefaultResponse Node.

Throws:

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

readDefaultResponse

Integer readDefaultResponse()
                     throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Integer value read from the server.

Throws:

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

writeDefaultResponse

void writeDefaultResponse(Integer defaultResponse)
                   throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

defaultResponse - the Integer value to write to the server.

Throws:

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

readDefaultResponseAsync

CompletableFuture<? extends Integer> readDefaultResponseAsync()

An asynchronous implementation of readDefaultResponse().

Returns:

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

writeDefaultResponseAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeDefaultResponseAsync(Integer defaultResponse)

An asynchronous implementation of writeDefaultResponse(Integer).

Returns:

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

getDefaultResponseNode

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

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

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

Returns:

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

getDefaultResponseNodeAsync

CompletableFuture<? extends PropertyType> getDefaultResponseNodeAsync()

Asynchronous implementation of getDefaultResponseNode().

Returns:

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

getOkResponse

Integer getOkResponse()
               throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the OkResponse Node.

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

Returns:

the local value of the OkResponse Node.

Throws:

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

setOkResponse

void setOkResponse(Integer okResponse)
            throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the OkResponse Node.

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

Parameters:

okResponse - the local value to set for the OkResponse Node.

Throws:

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

readOkResponse

Integer readOkResponse()
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Integer value read from the server.

Throws:

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

writeOkResponse

void writeOkResponse(Integer okResponse)
              throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

okResponse - the Integer value to write to the server.

Throws:

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

readOkResponseAsync

CompletableFuture<? extends Integer> readOkResponseAsync()

An asynchronous implementation of readOkResponse().

Returns:

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

writeOkResponseAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeOkResponseAsync(Integer okResponse)

An asynchronous implementation of writeOkResponse(Integer).

Returns:

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

getOkResponseNode

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

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

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

Returns:

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

getOkResponseNodeAsync

CompletableFuture<? extends PropertyType> getOkResponseNodeAsync()

Asynchronous implementation of getOkResponseNode().

Returns:

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

getCancelResponse

Integer getCancelResponse()
                   throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the CancelResponse Node.

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

Returns:

the local value of the CancelResponse Node.

Throws:

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

setCancelResponse

void setCancelResponse(Integer cancelResponse)
                throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the CancelResponse Node.

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

Parameters:

cancelResponse - the local value to set for the CancelResponse Node.

Throws:

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

readCancelResponse

Integer readCancelResponse()
                    throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Integer value read from the server.

Throws:

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

writeCancelResponse

void writeCancelResponse(Integer cancelResponse)
                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

cancelResponse - the Integer value to write to the server.

Throws:

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

readCancelResponseAsync

CompletableFuture<? extends Integer> readCancelResponseAsync()

An asynchronous implementation of readCancelResponse().

Returns:

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

writeCancelResponseAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeCancelResponseAsync(Integer cancelResponse)

An asynchronous implementation of writeCancelResponse(Integer).

Returns:

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

getCancelResponseNode

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

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

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

Returns:

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

getCancelResponseNodeAsync

CompletableFuture<? extends PropertyType> getCancelResponseNodeAsync()

Asynchronous implementation of getCancelResponseNode().

Returns:

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

getLastResponse

Integer getLastResponse()
                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the local value of the LastResponse Node.

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

Returns:

the local value of the LastResponse Node.

Throws:

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

setLastResponse

void setLastResponse(Integer lastResponse)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the LastResponse Node.

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

Parameters:

lastResponse - the local value to set for the LastResponse Node.

Throws:

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

readLastResponse

Integer readLastResponse()
                  throws org.eclipse.milo.opcua.stack.core.UaException

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

Returns:

the Integer value read from the server.

Throws:

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

writeLastResponse

void writeLastResponse(Integer lastResponse)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

lastResponse - the Integer value to write to the server.

Throws:

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

readLastResponseAsync

CompletableFuture<? extends Integer> readLastResponseAsync()

An asynchronous implementation of readLastResponse().

Returns:

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

writeLastResponseAsync

CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeLastResponseAsync(Integer lastResponse)

An asynchronous implementation of writeLastResponse(Integer).

Returns:

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

getLastResponseNode

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

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

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

Returns:

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

getLastResponseNodeAsync

CompletableFuture<? extends PropertyType> getLastResponseNodeAsync()

Asynchronous implementation of getLastResponseNode().

Returns:

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

getEnabledState

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

Get the local value of the EnabledState Node.

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

Specified by:

getEnabledState in interface ConditionType

Returns:

the local value of the EnabledState Node.

Throws:

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

setEnabledState

void setEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState)
              throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the EnabledState Node.

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

Specified by:

setEnabledState in interface ConditionType

Parameters:

enabledState - the local value to set for the EnabledState Node.

Throws:

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

readEnabledState

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

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

Specified by:

readEnabledState in interface ConditionType

Returns:

the LocalizedText value read from the server.

Throws:

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

writeEnabledState

void writeEnabledState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText enabledState)
                throws org.eclipse.milo.opcua.stack.core.UaException

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

Specified by:

writeEnabledState in interface ConditionType

Parameters:

enabledState - the LocalizedText value to write to the server.

Throws:

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

readEnabledStateAsync

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

An asynchronous implementation of readEnabledState().

Specified by:

readEnabledStateAsync in interface ConditionType

Returns:

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

writeEnabledStateAsync

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

An asynchronous implementation of writeEnabledState(LocalizedText).

Specified by:

writeEnabledStateAsync in interface ConditionType

Returns:

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

getEnabledStateNode

TwoStateVariableType getEnabledStateNode()
                                  throws org.eclipse.milo.opcua.stack.core.UaException

Get the EnabledState TwoStateVariableType Node, or null if it does not exist.

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

Specified by:

getEnabledStateNode in interface ConditionType

Returns:

the EnabledState TwoStateVariableType 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.

getEnabledStateNodeAsync

CompletableFuture<? extends TwoStateVariableType> getEnabledStateNodeAsync()

Asynchronous implementation of getEnabledStateNode().

Specified by:

getEnabledStateNodeAsync in interface ConditionType

Returns:

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

getDialogState

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

Get the local value of the DialogState Node.

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

Returns:

the local value of the DialogState Node.

Throws:

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

setDialogState

void setDialogState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText dialogState)
             throws org.eclipse.milo.opcua.stack.core.UaException

Set the local value of the DialogState Node.

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

Parameters:

dialogState - the local value to set for the DialogState Node.

Throws:

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

readDialogState

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

Read the value of the DialogState 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.

writeDialogState

void writeDialogState(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText dialogState)
               throws org.eclipse.milo.opcua.stack.core.UaException

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

Parameters:

dialogState - the LocalizedText value to write to the server.

Throws:

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

readDialogStateAsync

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

An asynchronous implementation of readDialogState().

Returns:

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

writeDialogStateAsync

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

An asynchronous implementation of writeDialogState(LocalizedText).

Returns:

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

getDialogStateNode

TwoStateVariableType getDialogStateNode()
                                 throws org.eclipse.milo.opcua.stack.core.UaException

Get the DialogState TwoStateVariableType Node, or null if it does not exist.

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

Returns:

the DialogState TwoStateVariableType 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.

getDialogStateNodeAsync

CompletableFuture<? extends TwoStateVariableType> getDialogStateNodeAsync()

Asynchronous implementation of getDialogStateNode().

Returns:

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