yang/yang-model-api/src/main/java/org/opendaylight/yangtools/yang/model/api/OperationDefinition.java

   1 /*
   2  * Copyright (c) 2016 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.yangtools.yang.model.api;
   9
  10 import com.google.common.annotations.Beta;
  11 import java.util.Collection;
  12
  13 /**
  14  * Common interface for an operation.
  15  */
  16 @Beta
  17 public interface OperationDefinition extends SchemaNode {
  18     /**
  19      * Returns the set of type definitions declared under this operation.
  20      *
  21      * @return Set of type definitions declared under this operation.
  22      */
  23     Collection<? extends TypeDefinition<?>> getTypeDefinitions();
  24
  25     /**
  26      * Returns the set of grouping statements declared under this operation.
  27      *
  28      * @return Set of grouping statements declared under this operation.
  29      */
  30     Collection<? extends GroupingDefinition> getGroupings();
  31
  32     /**
  33      * Returns definition of input parameters for this operation.
  34      *
  35      * @return Definition of input parameters for this operation.
  36      *         The substatements of input define nodes under the operation's input node.
  37      */
  38     InputSchemaNode getInput();
  39
  40     /**
  41      * Returns definition of output parameters for this operation.
  42      *
  43      * @return Definition of output parameters for this operation. The
  44      *         substatements of output define nodes under the operation's output node.
  45      */
  46     OutputSchemaNode getOutput();
  47 }