org.jboss.shrinkwrap.descriptor.api.connector15.OutboundResourceadapterType Maven / Gradle / Ivy

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

import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.connector15.ConnectionDefinitionType;
import org.jboss.shrinkwrap.descriptor.api.connector15.TransactionSupportType;
import org.jboss.shrinkwrap.descriptor.api.connector15.AuthenticationMechanismType;
import org.jboss.shrinkwrap.descriptor.api.connector.*;
import org.jboss.shrinkwrap.descriptor.api.connector.JeeOutboundResourceadapterCommonType;

import org.jboss.shrinkwrap.descriptor.api.connector15.ConnectionDefinitionType;
import org.jboss.shrinkwrap.descriptor.api.connector15.AuthenticationMechanismType;/**
 * This interface defines the contract for the  outbound-resourceadapterType  xsd type 
 * @author Ralf Battenfeld
 * @author Andrew Lee Rubinger
 * @author George Gastaldi
 */
public interface OutboundResourceadapterType extends Child, 
    JeeOutboundResourceadapterCommonType,
    ConnectionDefinitionType>,
    AuthenticationMechanismType>> { 

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: OutboundResourceadapterType ElementName: j2ee:connection-definitionType ElementType : connection-definition
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new connection-definition element 
    * @return the new created instance of ConnectionDefinitionType> 
    */
   public ConnectionDefinitionType> createConnectionDefinition();

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

   /**
    * Removes all connection-definition elements 
    * @return the current instance of ConnectionDefinitionType> 
    */
   public OutboundResourceadapterType removeAllConnectionDefinition();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: OutboundResourceadapterType ElementName: j2ee:transaction-supportType ElementType : transaction-support
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: true isDataType: false
   // --------------------------------------------------------------------------------------------------------||
   /**
    * Sets the transaction-support element
    * @param transactionSupport the value for the element transaction-support 
    * @return the current instance of OutboundResourceadapterType 
    */
   public OutboundResourceadapterType transactionSupport(TransactionSupportType transactionSupport);
   /**
    * Sets the transaction-support element
    * @param transactionSupport the value for the element transaction-support 
    * @return the current instance of OutboundResourceadapterType 
    */
   public OutboundResourceadapterType transactionSupport(String transactionSupport);

   /**
    * Returns the transaction-support element
    * @return the value found for the element transaction-support 
    */
   public TransactionSupportType getTransactionSupport();

   /**
    * Returns the transaction-support element
    * @return the value found for the element transaction-support 
    */
   public String  getTransactionSupportAsString();

   /**
    * Removes the transaction-support attribute 
    * @return the current instance of OutboundResourceadapterType 
    */
   public OutboundResourceadapterType removeTransactionSupport();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: OutboundResourceadapterType ElementName: j2ee:authentication-mechanismType ElementType : authentication-mechanism
   // MaxOccurs: -unbounded  isGeneric: true   isAttribute: false isEnum: false isDataType: false
   // --------------------------------------------------------------------------------------------------------||

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

   /**
    * Creates a new authentication-mechanism element 
    * @return the new created instance of AuthenticationMechanismType> 
    */
   public AuthenticationMechanismType> createAuthenticationMechanism();

   /**
    * Returns all authentication-mechanism elements
    * @return list of authentication-mechanism 
    */
   public List>> getAllAuthenticationMechanism();

   /**
    * Removes all authentication-mechanism elements 
    * @return the current instance of AuthenticationMechanismType> 
    */
   public OutboundResourceadapterType removeAllAuthenticationMechanism();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: OutboundResourceadapterType ElementName: xsd:boolean ElementType : reauthentication-support
   // MaxOccurs: -  isGeneric: true   isAttribute: false isEnum: false isDataType: true
   // --------------------------------------------------------------------------------------------------------||

   /**
    * Sets the reauthentication-support element
    * @param reauthenticationSupport the value for the element reauthentication-support 
    * @return the current instance of OutboundResourceadapterType 
    */
   public OutboundResourceadapterType reauthenticationSupport(Boolean reauthenticationSupport);

   /**
    * Returns the reauthentication-support element
    * @return the node defined for the element reauthentication-support 
    */
   public Boolean isReauthenticationSupport();

   /**
    * Removes the reauthentication-support element 
    * @return the current instance of OutboundResourceadapterType 
    */
   public OutboundResourceadapterType removeReauthenticationSupport();

 
   // --------------------------------------------------------------------------------------------------------||
   // ClassName: OutboundResourceadapterType 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 OutboundResourceadapterType 
    */
   public OutboundResourceadapterType 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 OutboundResourceadapterType 
    */
   public OutboundResourceadapterType removeId();
}