org.jboss.shrinkwrap.descriptor.api.validationMapping11.ConstraintType Maven / Gradle / Ivy

package org.jboss.shrinkwrap.descriptor.api.validationMapping11; 

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.GroupsType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.PayloadType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.ElementType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.*;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.MapConstraintCommonType;

import org.jboss.shrinkwrap.descriptor.api.validationMapping11.GroupsType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.PayloadType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping11.ElementType;/**
 * This interface defines the contract for the  constraintType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface ConstraintType extends Child, 
    MapConstraintCommonType,
    GroupsType>,
    PayloadType>,
    ElementType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ConstraintType ElementName: xsd:string ElementType : message
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the message element
    * @param message the value for the element message 
    * @return the current instance of ConstraintType 
    */
   public ConstraintType message(String message);

   /**
    * Returns the message element
    * @return the node defined for the element message 
    */
   public String getMessage();

   /**
    * Removes the message element 
    * @return the current instance of ConstraintType 
    */
   public ConstraintType removeMessage();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ConstraintType ElementName: map:groupsType ElementType : groups
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new groups element with the given value will be created.
    * Otherwise, the existing groups element will be returned.
    * @return  a new or existing instance of GroupsType> 
    */
   public GroupsType> getOrCreateGroups();

   /**
    * Removes the groups element 
    * @return the current instance of ConstraintType 
    */
   public ConstraintType removeGroups();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ConstraintType ElementName: map:payloadType ElementType : payload
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new payload element with the given value will be created.
    * Otherwise, the existing payload element will be returned.
    * @return  a new or existing instance of PayloadType> 
    */
   public PayloadType> getOrCreatePayload();

   /**
    * Removes the payload element 
    * @return the current instance of ConstraintType 
    */
   public ConstraintType removePayload();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ConstraintType ElementName: map:elementType ElementType : element
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new element element will be created and returned.
    * Otherwise, the first existing element element will be returned.
    * @return the instance defined for the element element 
    */
   public ElementType> getOrCreateElement();

   /**
    * Creates a new element element 
    * @return the new created instance of ElementType> 
    */
   public ElementType> createElement();

   /**
    * Returns all element elements
    * @return list of element 
    */
   public List>> getAllElement();

   /**
    * Removes all element elements 
    * @return the current instance of ElementType> 
    */
   public ConstraintType removeAllElement();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ConstraintType ElementName: xsd:string ElementType : annotation
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the annotation attribute
    * @param annotation the value for the attribute annotation 
    * @return the current instance of ConstraintType 
    */
   public ConstraintType annotation(String annotation);

   /**
    * Returns the annotation attribute
    * @return the value defined for the attribute annotation 
    */
   public String getAnnotation();

   /**
    * Removes the annotation attribute 
    * @return the current instance of ConstraintType 
    */
   public ConstraintType removeAnnotation();
}