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

Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
Client View of the ShrinkWrap Descriptors Project
The newest version!
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.BeanType;
import org.jboss.shrinkwrap.descriptor.api.validationMapping10.ConstraintDefinitionType;
import org.jboss.shrinkwrap.descriptor.api.Descriptor;
import org.jboss.shrinkwrap.descriptor.api.DescriptorNamespace;

import org.jboss.shrinkwrap.descriptor.api.validationMapping.*;
/** 
 *  
 * This deployment descriptor provides the functionalities as described in the  specification
 * 
 
 * Example:
 *  
 *  
 *     ValidationMappingDescriptor descriptor = Descriptors.create(ValidationMappingDescriptor.class);
 *  
 *
 *
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface ValidationMappingDescriptor extends Descriptor, DescriptorNamespace, 
    ValidationMappingCommonDescriptor, 
    ConstraintDefinitionType> {

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ValidationMappingDescriptor ElementName: xsd:string ElementType : default-package
   // MaxOccurs: -  isGeneric: false   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the default-package element
    * @param defaultPackage the value for the element default-package 
    * @return the current instance of ValidationMappingDescriptor 
    */
   public ValidationMappingDescriptor defaultPackage(String defaultPackage);

   /**
    * Returns the default-package element
    * @return the node defined for the element default-package 
    */
   public String getDefaultPackage();

   /**
    * Removes the default-package element 
    * @return the current instance of ValidationMappingDescriptor 
    */
   public ValidationMappingDescriptor removeDefaultPackage();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ValidationMappingDescriptor ElementName: map:beanType ElementType : bean
   // MaxOccurs: -unbounded  isGeneric: false   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new bean element 
    * @return the new created instance of BeanType 
    */
   public BeanType createBean();

   /**
    * Returns all bean elements
    * @return list of bean 
    */
   public List> getAllBean();

   /**
    * Removes all bean elements 
    * @return the current instance of BeanType 
    */
   public ValidationMappingDescriptor removeAllBean();
 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: ValidationMappingDescriptor ElementName: map:constraint-definitionType ElementType : constraint-definition
   // MaxOccurs: -unbounded  isGeneric: false   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new constraint-definition element 
    * @return the new created instance of ConstraintDefinitionType 
    */
   public ConstraintDefinitionType createConstraintDefinition();

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

   /**
    * Removes all constraint-definition elements 
    * @return the current instance of ConstraintDefinitionType 
    */
   public ValidationMappingDescriptor removeAllConstraintDefinition();
}