dom/mdsal-dom-api/src/main/java/org/opendaylight/mdsal/dom/api/DOMRpcResult.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.mdsal.dom.api;
   9
  10 import java.util.Collection;
  11 import org.eclipse.jdt.annotation.NonNullByDefault;
  12 import org.eclipse.jdt.annotation.Nullable;
  13 import org.opendaylight.yangtools.yang.common.RpcError;
  14 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  15
  16 /**
  17  * Interface defining a result of an RPC call.
  18  */
  19 // FIXME: rename to DOMOperationResult
  20 @NonNullByDefault
  21 public interface DOMRpcResult {
  22     /**
  23      * Returns a set of errors and warnings which occurred during processing the call.
  24      *
  25      * @return a Collection of {@link RpcError}, guaranteed to be non-null. In case no errors are reported, an empty
  26      *         collection is returned.
  27      */
  28     Collection<? extends RpcError> errors();
  29
  30     /**
  31      * Returns the value result of the call or {code null} if no result is available.
  32      *
  33      * @return Invocation result, {@code null} if the operation has not produced a result. This might be the case if the
  34      *         operation does not produce a result, or if it failed.
  35      */
  36     @Nullable ContainerNode value();
  37 }