org.jboss.shrinkwrap.descriptor.api.javaee5.ResourceRefType Maven / Gradle / Ivy
package org.jboss.shrinkwrap.descriptor.api.javaee5;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.javaee5.ResAuthType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.ResSharingScopeType;
import org.jboss.shrinkwrap.descriptor.api.javaee5.InjectionTargetType;
import org.jboss.shrinkwrap.descriptor.api.javaee.*;
/**
* This interface defines the contract for the resource-refType xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface ResourceRefType extends Child,
JavaeeResourceRefCommonType> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: ResourceRefType ElementName: xsd:string ElementType : mapped-name
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the mapped-name element
* @param mappedName the value for the element mapped-name
* @return the current instance of ResourceRefType
*/
public ResourceRefType mappedName(String mappedName);
/**
* Returns the mapped-name element
* @return the node defined for the element mapped-name
*/
public String getMappedName();
/**
* Removes the mapped-name element
* @return the current instance of ResourceRefType
*/
public ResourceRefType removeMappedName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ResourceRefType ElementName: javaee:injection-targetType ElementType : injection-target
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new injection-target element will be created and returned.
* Otherwise, the first existing injection-target element will be returned.
* @return the instance defined for the element injection-target
*/
public InjectionTargetType> getOrCreateInjectionTarget();
/**
* Creates a new injection-target element
* @return the new created instance of InjectionTargetType>
*/
public InjectionTargetType> createInjectionTarget();
/**
* Returns all injection-target elements
* @return list of injection-target
*/
public List>> getAllInjectionTarget();
/**
* Removes all injection-target elements
* @return the current instance of InjectionTargetType>
*/
public ResourceRefType removeAllInjectionTarget();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ResourceRefType ElementName: xsd:string ElementType : description
// MaxOccurs: -unbounded isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Creates for all String objects representing description elements,
* a new description element
* @param values list of description objects
* @return the current instance of ResourceRefType
*/
public ResourceRefType description(String ... values);
/**
* Returns all description elements
* @return list of description
*/
public List getAllDescription();
/**
* Removes the description element
* @return the current instance of ResourceRefType
*/
public ResourceRefType removeAllDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ResourceRefType ElementName: xsd:token ElementType : res-ref-name
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the res-ref-name element
* @param resRefName the value for the element res-ref-name
* @return the current instance of ResourceRefType
*/
public ResourceRefType resRefName(String resRefName);
/**
* Returns the res-ref-name element
* @return the node defined for the element res-ref-name
*/
public String getResRefName();
/**
* Removes the res-ref-name element
* @return the current instance of ResourceRefType
*/
public ResourceRefType removeResRefName();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ResourceRefType ElementName: xsd:token ElementType : res-type
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the res-type element
* @param resType the value for the element res-type
* @return the current instance of ResourceRefType
*/
public ResourceRefType resType(String resType);
/**
* Returns the res-type element
* @return the node defined for the element res-type
*/
public String getResType();
/**
* Removes the res-type element
* @return the current instance of ResourceRefType
*/
public ResourceRefType removeResType();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ResourceRefType ElementName: javaee:res-authType ElementType : res-auth
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the res-auth element
* @param resAuth the value for the element res-auth
* @return the current instance of ResourceRefType
*/
public ResourceRefType resAuth(ResAuthType resAuth);
/**
* Sets the res-auth element
* @param resAuth the value for the element res-auth
* @return the current instance of ResourceRefType
*/
public ResourceRefType resAuth(String resAuth);
/**
* Returns the res-auth element
* @return the value found for the element res-auth
*/
public ResAuthType getResAuth();
/**
* Returns the res-auth element
* @return the value found for the element res-auth
*/
public String getResAuthAsString();
/**
* Removes the res-auth attribute
* @return the current instance of ResourceRefType
*/
public ResourceRefType removeResAuth();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ResourceRefType ElementName: javaee:res-sharing-scopeType ElementType : res-sharing-scope
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the res-sharing-scope element
* @param resSharingScope the value for the element res-sharing-scope
* @return the current instance of ResourceRefType
*/
public ResourceRefType resSharingScope(ResSharingScopeType resSharingScope);
/**
* Sets the res-sharing-scope element
* @param resSharingScope the value for the element res-sharing-scope
* @return the current instance of ResourceRefType
*/
public ResourceRefType resSharingScope(String resSharingScope);
/**
* Returns the res-sharing-scope element
* @return the value found for the element res-sharing-scope
*/
public ResSharingScopeType getResSharingScope();
/**
* Returns the res-sharing-scope element
* @return the value found for the element res-sharing-scope
*/
public String getResSharingScopeAsString();
/**
* Removes the res-sharing-scope attribute
* @return the current instance of ResourceRefType
*/
public ResourceRefType removeResSharingScope();
// --------------------------------------------------------------------------------------------------------||
// ClassName: ResourceRefType 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 ResourceRefType
*/
public ResourceRefType 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 ResourceRefType
*/
public ResourceRefType removeId();
}