Package org.opendaylight.yang.gen.v1.urn.opendaylight.flat.batch.service.rev160321

Interface ProcessFlatBatchInput

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.Augmentable<ProcessFlatBatchInput>, org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, NodeContextRef, org.opendaylight.yangtools.yang.binding.RpcInput
@Generated("mdsal-binding-generator") public interface ProcessFlatBatchInput extends org.opendaylight.yangtools.yang.binding.RpcInput, org.opendaylight.yangtools.yang.binding.Augmentable<ProcessFlatBatchInput>, NodeContextRef

This class represents the following YANG schema fragment defined in module sal-flat-batch 

 input input {
   uses inv:node-context-ref;
   list batch {
     key batch-order;
     uses batch:batch-order-grouping;
     choice batch-choice;
   }
   leaf exit-on-first-error {
     type boolean;
   }
 }

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      default Class<ProcessFlatBatchInput> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      Specified by:
      implementedInterface in interface NodeContextRef
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.RpcInput

    • bindingHashCode

      static int bindingHashCode(@NonNull ProcessFlatBatchInput obj)
      Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
      Parameters:
      obj - Object for which to generate hashCode() result.
      Returns:
      Hash code value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • bindingEquals

      static boolean bindingEquals(@NonNull ProcessFlatBatchInput thisObj, Object obj)
      Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
      Parameters:
      thisObj - Object acting as the receiver of equals invocation
      obj - Object acting as argument to equals invocation
      Returns:
      True if thisObj and obj are considered equal
      Throws:
      NullPointerException - if thisObj is null

    • bindingToString

      static String bindingToString(@NonNull ProcessFlatBatchInput obj)
      Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
      Parameters:
      obj - Object for which to generate toString() result.
      Returns:
      String value of data modeled by this interface.
      Throws:
      NullPointerException - if obj is null

    • getBatch

      @Nullable Map<BatchKey,Batch> getBatch()
      Return batch, or null if it is not present.
      Returns:
      Map<BatchKey, Batch> batch, or null if it is not present.

    • nonnullBatch

      default @NonNull Map<BatchKey,Batch> nonnullBatch()
      Return batch, or an empty list if it is not present.
      Returns:
      Map<BatchKey, Batch> batch, or an empty list if it is not present.

    • getExitOnFirstError

      Boolean getExitOnFirstError()
      Return exitOnFirstError, or null if it is not present. 
           
         If true then batch will execute all steps and report list of occurred errors,
         otherwise there will be only first error reported and execution will be stop
         right there.
      Returns:
      Boolean exitOnFirstError, or null if it is not present.

    • requireExitOnFirstError

      default @NonNull Boolean requireExitOnFirstError()
      Return exitOnFirstError, guaranteed to be non-null. 
           
         If true then batch will execute all steps and report list of occurred errors,
         otherwise there will be only first error reported and execution will be stop
         right there.
      Returns:
      Boolean exitOnFirstError, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if exitOnFirstError is not present