org.jboss.shrinkwrap.descriptor.api.facesconfig22.FacesConfigFlowDefinitionFlowCallType Maven / Gradle / Ivy

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

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.facesconfig22.FacesConfigFlowDefinitionFlowCallFlowReferenceType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig22.FacesConfigFlowDefinitionFlowCallOutboundParameterType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.*;
import org.jboss.shrinkwrap.descriptor.api.facesconfig.JavaeeFacesConfigFlowDefinitionFlowCallCommonType;

import org.jboss.shrinkwrap.descriptor.api.facesconfig22.FacesConfigFlowDefinitionFlowCallFlowReferenceType;
import org.jboss.shrinkwrap.descriptor.api.facesconfig22.FacesConfigFlowDefinitionFlowCallOutboundParameterType;/**
 * This interface defines the contract for the  faces-config-flow-definition-flow-callType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 */
public interface FacesConfigFlowDefinitionFlowCallType extends Child, 
    JavaeeFacesConfigFlowDefinitionFlowCallCommonType,
    FacesConfigFlowDefinitionFlowCallFlowReferenceType>,
    FacesConfigFlowDefinitionFlowCallOutboundParameterType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigFlowDefinitionFlowCallType ElementName: javaee:faces-config-flow-definition-flow-call-flow-referenceType ElementType : flow-reference
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

   /**
    * If not already created, a new flow-reference element with the given value will be created.
    * Otherwise, the existing flow-reference element will be returned.
    * @return  a new or existing instance of FacesConfigFlowDefinitionFlowCallFlowReferenceType> 
    */
   public FacesConfigFlowDefinitionFlowCallFlowReferenceType> getOrCreateFlowReference();

   /**
    * Removes the flow-reference element 
    * @return the current instance of FacesConfigFlowDefinitionFlowCallType 
    */
   public FacesConfigFlowDefinitionFlowCallType removeFlowReference();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigFlowDefinitionFlowCallType ElementName: javaee:faces-config-flow-definition-flow-call-outbound-parameterType ElementType : outbound-parameter
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new outbound-parameter element 
    * @return the new created instance of FacesConfigFlowDefinitionFlowCallOutboundParameterType> 
    */
   public FacesConfigFlowDefinitionFlowCallOutboundParameterType> createOutboundParameter();

   /**
    * Returns all outbound-parameter elements
    * @return list of outbound-parameter 
    */
   public List>> getAllOutboundParameter();

   /**
    * Removes all outbound-parameter elements 
    * @return the current instance of FacesConfigFlowDefinitionFlowCallOutboundParameterType> 
    */
   public FacesConfigFlowDefinitionFlowCallType removeAllOutboundParameter();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: FacesConfigFlowDefinitionFlowCallType ElementName: xsd:ID ElementType : id
   // MaxOccurs: -  isGeneric: true   isAttribute: true isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Returns the id attribute
    * @return the value defined for the attribute id 
    */
   public String getId();

   /**
    * Removes the id attribute 
    * @return the current instance of FacesConfigFlowDefinitionFlowCallType 
    */
   public FacesConfigFlowDefinitionFlowCallType removeId();
}