opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/RpcDefinition.java

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\r
   4  * This program and the accompanying materials are made available under the\r
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,\r
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html\r
   7  */\r
   8 package org.opendaylight.controller.yang.model.api;\r
   9 \r
  10 import java.util.Set;\r
  11 \r
  12 /**\r
  13  * Interface describing YANG 'rpc' statement.\r
  14  * <p>\r
  15  * The rpc statement defines an rpc node in the schema tree. Under the rpc node,\r
  16  * a schema node with the name 'input', and a schema node with the name 'output'\r
  17  * are also defined.\r
  18  * </p>\r
  19  */\r
  20 public interface RpcDefinition extends SchemaNode {\r
  21 \r
  22     /**\r
  23      * @return Set of type definitions declared under this rpc statement.\r
  24      */\r
  25     Set<TypeDefinition<?>> getTypeDefinitions();\r
  26 \r
  27     /**\r
  28      * @return Set of grouping statements declared under this rpc statement.\r
  29      */\r
  30     Set<GroupingDefinition> getGroupings();\r
  31 \r
  32     /**\r
  33      * @return Definition of input parameters to the RPC operation. The\r
  34      *         substatements of input define nodes under the RPC's input node.\r
  35      */\r
  36     ContainerSchemaNode getInput();\r
  37 \r
  38     /**\r
  39      * @return Definition of output parameters to the RPC operation. The\r
  40      *         substatements of output define nodes under the RPC's output node.\r
  41      */\r
  42     ContainerSchemaNode getOutput();\r
  43 \r
  44 }\r