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

import java.util.concurrent.CompletableFuture;

import org.eclipse.milo.opcua.sdk.client.model.types.variables.PropertyType;
import org.eclipse.milo.opcua.sdk.core.QualifiedProperty;
import org.eclipse.milo.opcua.sdk.core.ValueRanks;
import org.eclipse.milo.opcua.stack.core.UaException;
import org.eclipse.milo.opcua.stack.core.types.builtin.ExpandedNodeId;
import org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode;
import org.eclipse.milo.opcua.stack.core.types.structured.NetworkGroupDataType;

public interface NonTransparentNetworkRedundancyType extends NonTransparentRedundancyType {
    QualifiedProperty<NetworkGroupDataType[]> SERVER_NETWORK_GROUPS = new QualifiedProperty<>(
        "http://opcfoundation.org/UA/",
        "ServerNetworkGroups",
        ExpandedNodeId.parse("nsu=http://opcfoundation.org/UA/;i=11944"),
        ValueRanks.OneDimension,
        NetworkGroupDataType[].class
    );

    /**
     * Get the local value of the ServerNetworkGroups Node.
     * <p>
     * The returned value is the last seen; it is not read live from the server.
     *
     * @return the local value of the ServerNetworkGroups Node.
     * @throws UaException if an error occurs creating or getting the ServerNetworkGroups Node.
     */
    NetworkGroupDataType[] getServerNetworkGroups() throws UaException;

    /**
     * Set the local value of the ServerNetworkGroups Node.
     * <p>
     * The value is only updated locally; it is not written to the server.
     *
     * @param serverNetworkGroups the local value to set for the ServerNetworkGroups Node.
     * @throws UaException if an error occurs creating or getting the ServerNetworkGroups Node.
     */
    void setServerNetworkGroups(NetworkGroupDataType[] serverNetworkGroups) throws UaException;

    /**
     * Read the value of the ServerNetworkGroups Node from the server and update the local value if the
     * operation succeeds.
     *
     * @return the {@link NetworkGroupDataType[]} value read from the server.
     * @throws UaException if a service- or operation-level error occurs.
     */
    NetworkGroupDataType[] readServerNetworkGroups() throws UaException;

    /**
     * Write a new value for the ServerNetworkGroups Node to the server and update the local value if
     * the operation succeeds.
     *
     * @param serverNetworkGroups the {@link NetworkGroupDataType[]} value to write to the server.
     * @throws UaException if a service- or operation-level error occurs.
     */
    void writeServerNetworkGroups(NetworkGroupDataType[] serverNetworkGroups) throws UaException;

    /**
     * An asynchronous implementation of {@link #readServerNetworkGroups()}.
     *
     * @return a CompletableFuture that completes successfully with the property value or completes
     * exceptionally if an operation- or service-level error occurs.
     */
    CompletableFuture<? extends NetworkGroupDataType[]> readServerNetworkGroupsAsync();

    /**
     * An asynchronous implementation of {@link #writeServerNetworkGroups(NetworkGroupDataType[])}.
     *
     * @return a CompletableFuture that completes successfully with the operation result or
     * completes exceptionally if a service-level error occurs.
     */
    CompletableFuture<StatusCode> writeServerNetworkGroupsAsync(
        NetworkGroupDataType[] serverNetworkGroups);

    /**
     * Get the ServerNetworkGroups {@link PropertyType} Node, or {@code null} if it does not exist.
     * <p>
     * The Node is created when first accessed and cached for subsequent calls.
     *
     * @return the ServerNetworkGroups {@link PropertyType} Node, or {@code null} if it does not exist.
     * @throws UaException if an error occurs creating or getting the Node.
     */
    PropertyType getServerNetworkGroupsNode() throws UaException;

    /**
     * Asynchronous implementation of {@link #getServerNetworkGroupsNode()}.
     *
     * @return a CompletableFuture that completes successfully with the
     * ? extends PropertyType Node or completes exceptionally if an error occurs
     * creating or getting the Node.
     */
    CompletableFuture<? extends PropertyType> getServerNetworkGroupsNodeAsync();
}
