org.jboss.shrinkwrap.descriptor.api.validationMapping10.FieldType Maven / Gradle / Ivy

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

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.validationMapping10.ConstraintType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.*;
import org.jboss.shrinkwrap.descriptor.api.validationMapping.MapFieldCommonType;

import org.jboss.shrinkwrap.descriptor.api.validationMapping10.ConstraintType;/**
 * This interface defines the contract for the  fieldType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface FieldType extends Child, 
    MapFieldCommonType,
    ConstraintType>> { 

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

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

   /**
    * Returns the valid element
    * @return the node defined for the element valid 
    */
   public String getValid();

   /**
    * Removes the valid element 
    * @return the current instance of FieldType 
    */
   public FieldType removeValid();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FieldType ElementName: map:constraintType ElementType : constraint
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new constraint element 
    * @return the new created instance of ConstraintType> 
    */
   public ConstraintType> createConstraint();

   /**
    * Returns all constraint elements
    * @return list of constraint 
    */
   public List>> getAllConstraint();

   /**
    * Removes all constraint elements 
    * @return the current instance of ConstraintType> 
    */
   public FieldType removeAllConstraint();

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

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

   /**
    * Returns the name attribute
    * @return the value defined for the attribute name 
    */
   public String getName();

   /**
    * Removes the name attribute 
    * @return the current instance of FieldType 
    */
   public FieldType removeName();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FieldType ElementName: xsd:boolean ElementType : ignore-annotations
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the ignore-annotations attribute
    * @param ignoreAnnotations the value for the attribute ignore-annotations 
    * @return the current instance of FieldType 
    */
   public FieldType ignoreAnnotations(Boolean ignoreAnnotations);

   /**
    * Returns the ignore-annotations attribute
    * @return the value defined for the attribute ignore-annotations 
    */
public Boolean isIgnoreAnnotations();

   /**
    * Removes the ignore-annotations attribute 
    * @return the current instance of FieldType 
    */
   public FieldType removeIgnoreAnnotations();
}