Package org.opendaylight.yangtools.yang.model.api

Interface OperationDefinition

All Superinterfaces:

DocumentedNode, DocumentedNode.WithStatus, SchemaNode

All Known Subinterfaces:

ActionDefinition, EffectiveStatementMixins.OperationDefinitionMixin<D>, RpcDefinition

All Known Implementing Classes:

ActionEffectiveStatementImpl, RpcEffectiveStatementImpl

@NonNullByDefault
public interface OperationDefinition
extends SchemaNode

Common interface for an operation, such as an RpcDefinition or an ActionDefinition. Note that this interface is not a DataSchemaNode, which renders compatibility problematic. Use toContainerLike() to get a ContainerLike, which can serve as a bridge.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

DocumentedNode.WithStatus

Method Summary

Modifier and Type	Method	Description
Collection<? extends GroupingDefinition>	getGroupings()	Returns the set of grouping statements declared under this operation.
InputSchemaNode	getInput()	Returns definition of input parameters for this operation.
OutputSchemaNode	getOutput()	Returns definition of output parameters for this operation.
Collection<? extends TypeDefinition<?>>	getTypeDefinitions()	Returns the set of type definitions declared under this operation.
default ContainerLikeCompat	toContainerLike()	Return a ContainerLike backed by this definition's getInput() and getOutput().

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode

getDescription, getReference, getUnknownSchemaNodes

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus

getStatus

Methods inherited from interface org.opendaylight.yangtools.yang.model.api.SchemaNode

getQName

Method Details

getTypeDefinitions

Collection<? extends TypeDefinition<?>> getTypeDefinitions()

Returns the set of type definitions declared under this operation.

Returns:

Set of type definitions declared under this operation.

getGroupings

Collection<? extends GroupingDefinition> getGroupings()

Returns the set of grouping statements declared under this operation.

Returns:

Set of grouping statements declared under this operation.

getInput

InputSchemaNode getInput()

Returns definition of input parameters for this operation.

Returns:

Definition of input parameters for this operation. The substatements of input define nodes under the operation's input node.

getOutput

OutputSchemaNode getOutput()

Returns definition of output parameters for this operation.

Returns:

Definition of output parameters for this operation. The substatements of output define nodes under the operation's output node.

toContainerLike

default ContainerLikeCompat toContainerLike()

Return a ContainerLike backed by this definition's getInput() and getOutput().

Returns:

A compatibility ContainerLike