Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client.model.variables

Interface SelectionListType

All Superinterfaces:
BaseDataVariableType, BaseVariableType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.VariableNode
All Known Implementing Classes:
SelectionListTypeNode
public interface SelectionListType extends BaseDataVariableType
See Also:

  • Field Details

    • SELECTIONS

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Object[]> SELECTIONS

    • SELECTION_DESCRIPTIONS

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

    • RESTRICT_TO_LIST

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<Boolean> RESTRICT_TO_LIST

  • Method Details

    • getSelections

      Object[] getSelections() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the Selections Node.

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

      Returns:
      the local value of the Selections Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Selections Node.

    • setSelections

      void setSelections(Object[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the Selections Node.

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

      Parameters:
      value - the local value to set for the Selections Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Selections Node.

    • readSelections

      Object[] readSelections() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the Selections 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.

    • writeSelections

      void writeSelections(Object[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the Selections Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the Object value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readSelectionsAsync

      CompletableFuture<? extends Object[]> readSelectionsAsync()
      An asynchronous implementation of readSelections().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeSelectionsAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSelectionsAsync(Object[] value)
      An asynchronous implementation of writeSelections(java.lang.Object[]).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getSelectionsNode

      PropertyType getSelectionsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the Selections PropertyType Node, or null if it does not exist.

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

      Returns:
      the Selections 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.

    • getSelectionsNodeAsync

      CompletableFuture<? extends PropertyType> getSelectionsNodeAsync()
      Asynchronous implementation of getSelectionsNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getSelectionDescriptions

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] getSelectionDescriptions() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the SelectionDescriptions Node.

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

      Returns:
      the local value of the SelectionDescriptions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SelectionDescriptions Node.

    • setSelectionDescriptions

      void setSelectionDescriptions(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the SelectionDescriptions Node.

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

      Parameters:
      value - the local value to set for the SelectionDescriptions Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the SelectionDescriptions Node.

    • readSelectionDescriptions

      org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] readSelectionDescriptions() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the SelectionDescriptions 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.

    • writeSelectionDescriptions

      void writeSelectionDescriptions(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the SelectionDescriptions 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.

    • readSelectionDescriptionsAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[]> readSelectionDescriptionsAsync()
      An asynchronous implementation of readSelectionDescriptions().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeSelectionDescriptionsAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeSelectionDescriptionsAsync(org.eclipse.milo.opcua.stack.core.types.builtin.LocalizedText[] value)
      An asynchronous implementation of writeSelectionDescriptions(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.

    • getSelectionDescriptionsNode

      PropertyType getSelectionDescriptionsNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the SelectionDescriptions PropertyType Node, or null if it does not exist.

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

      Returns:
      the SelectionDescriptions 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.

    • getSelectionDescriptionsNodeAsync

      CompletableFuture<? extends PropertyType> getSelectionDescriptionsNodeAsync()
      Asynchronous implementation of getSelectionDescriptionsNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.

    • getRestrictToList

      Boolean getRestrictToList() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the RestrictToList Node.

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

      Returns:
      the local value of the RestrictToList Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the RestrictToList Node.

    • setRestrictToList

      void setRestrictToList(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the RestrictToList Node.

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

      Parameters:
      value - the local value to set for the RestrictToList Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the RestrictToList Node.

    • readRestrictToList

      Boolean readRestrictToList() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the RestrictToList Node from the server and update the local value if the operation succeeds.
      Returns:
      the Boolean value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeRestrictToList

      void writeRestrictToList(Boolean value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the RestrictToList Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the Boolean value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readRestrictToListAsync

      CompletableFuture<? extends Boolean> readRestrictToListAsync()
      An asynchronous implementation of readRestrictToList().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeRestrictToListAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeRestrictToListAsync(Boolean value)
      An asynchronous implementation of writeRestrictToList(java.lang.Boolean).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getRestrictToListNode

      PropertyType getRestrictToListNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the RestrictToList PropertyType Node, or null if it does not exist.

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

      Returns:
      the RestrictToList 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.

    • getRestrictToListNodeAsync

      CompletableFuture<? extends PropertyType> getRestrictToListNodeAsync()
      Asynchronous implementation of getRestrictToListNode().
      Returns:
      a CompletableFuture that completes successfully with the PropertyType Node or completes exceptionally if an error occurs creating or getting the Node.