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

Interface SyntaxReferenceEntryType

All Superinterfaces:
BaseObjectType, DictionaryEntryType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
SyntaxReferenceEntryTypeNode
public interface SyntaxReferenceEntryType extends DictionaryEntryType
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String>
    COMMON_NAME
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getCommonName()
    Get the local value of the CommonName Node.
    PropertyType
    getCommonNameNode()
    Get the CommonName PropertyType Node, or null if it does not exist.
    CompletableFuture<? extends PropertyType>
    getCommonNameNodeAsync()
    Asynchronous implementation of getCommonNameNode().
    String
    readCommonName()
    Read the value of the CommonName Node from the server and update the local value if the operation succeeds.
    CompletableFuture<? extends String>
    readCommonNameAsync()
    An asynchronous implementation of readCommonName().
    void
    setCommonName(String value)
    Set the local value of the CommonName Node.
    void
    writeCommonName(String value)
    Write a new value for the CommonName Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeCommonNameAsync(String value)
    An asynchronous implementation of writeCommonName(java.lang.String).

    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

    • COMMON_NAME

      static final org.eclipse.milo.opcua.sdk.core.QualifiedProperty<String> COMMON_NAME

  • Method Details

    • getCommonName

      String getCommonName() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the CommonName Node.

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

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

    • setCommonName

      void setCommonName(String value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the CommonName Node.

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

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

    • readCommonName

      String readCommonName() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the CommonName 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.

    • writeCommonName

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

    • readCommonNameAsync

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

    • writeCommonNameAsync

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

    • getCommonNameNode

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

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

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

    • getCommonNameNodeAsync

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