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 import org.eclipse.jdt.annotation.NonNull;
  13
  14 /**
  15  * Common interface for an operation.
  16  */
  17 @Beta
  18 public interface OperationDefinition extends SchemaNode {
  19     /**
  20      * Returns the set of type definitions declared under this operation.
  21      *
  22      * @return Set of type definitions declared under this operation.
  23      */
  24     Collection<? extends @NonNull TypeDefinition<?>> getTypeDefinitions();
  25
  26     /**
  27      * Returns the set of grouping statements declared under this operation.
  28      *
  29      * @return Set of grouping statements declared under this operation.
  30      */
  31     Collection<? extends @NonNull GroupingDefinition> getGroupings();
  32
  33     /**
  34      * Returns definition of input parameters for this operation.
  35      *
  36      * @return Definition of input parameters for this operation.
  37      *         The substatements of input define nodes under the operation's input node.
  38      */
  39     InputSchemaNode getInput();
  40
  41     /**
  42      * Returns definition of output parameters for this operation.
  43      *
  44      * @return Definition of output parameters for this operation. The
  45      *         substatements of output define nodes under the operation's output node.
  46      */
  47     OutputSchemaNode getOutput();
  48 }