org.jboss.shrinkwrap.descriptor.api.ejbjar31.QueryType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of shrinkwrap-descriptors-api-javaee Show documentation
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.ejbjar31;
import java.util.ArrayList;
import java.util.List;
import org.jboss.shrinkwrap.descriptor.api.Child;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.QueryMethodType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.ResultTypeMappingType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.*;
import org.jboss.shrinkwrap.descriptor.api.ejbjar.JavaeeQueryCommonType;
import org.jboss.shrinkwrap.descriptor.api.ejbjar31.QueryMethodType;/**
* This interface defines the contract for the queryType
xsd type
* @author Ralf Battenfeld
* @author Andrew Lee Rubinger
* @author George Gastaldi
*/
public interface QueryType extends Child,
JavaeeQueryCommonType,
QueryMethodType>> {
// --------------------------------------------------------------------------------------------------------||
// ClassName: QueryType ElementName: xsd:string ElementType : description
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the description
element
* @param description the value for the element description
* @return the current instance of QueryType
*/
public QueryType description(String description);
/**
* Returns the description
element
* @return the node defined for the element description
*/
public String getDescription();
/**
* Removes the description
element
* @return the current instance of QueryType
*/
public QueryType removeDescription();
// --------------------------------------------------------------------------------------------------------||
// ClassName: QueryType ElementName: javaee:query-methodType ElementType : query-method
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* If not already created, a new query-method
element with the given value will be created.
* Otherwise, the existing query-method
element will be returned.
* @return a new or existing instance of QueryMethodType>
*/
public QueryMethodType> getOrCreateQueryMethod();
/**
* Removes the query-method
element
* @return the current instance of QueryType
*/
public QueryType removeQueryMethod();
// --------------------------------------------------------------------------------------------------------||
// ClassName: QueryType ElementName: javaee:result-type-mappingType ElementType : result-type-mapping
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: true isDataType: false
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the result-type-mapping
element
* @param resultTypeMapping the value for the element result-type-mapping
* @return the current instance of QueryType
*/
public QueryType resultTypeMapping(ResultTypeMappingType resultTypeMapping);
/**
* Sets the result-type-mapping
element
* @param resultTypeMapping the value for the element result-type-mapping
* @return the current instance of QueryType
*/
public QueryType resultTypeMapping(String resultTypeMapping);
/**
* Returns the result-type-mapping
element
* @return the value found for the element result-type-mapping
*/
public ResultTypeMappingType getResultTypeMapping();
/**
* Returns the result-type-mapping
element
* @return the value found for the element result-type-mapping
*/
public String getResultTypeMappingAsString();
/**
* Removes the result-type-mapping
attribute
* @return the current instance of QueryType
*/
public QueryType removeResultTypeMapping();
// --------------------------------------------------------------------------------------------------------||
// ClassName: QueryType ElementName: xsd:string ElementType : ejb-ql
// MaxOccurs: - isGeneric: true isAttribute: false isEnum: false isDataType: true
// --------------------------------------------------------------------------------------------------------||
/**
* Sets the ejb-ql
element
* @param ejbQl the value for the element ejb-ql
* @return the current instance of QueryType
*/
public QueryType ejbQl(String ejbQl);
/**
* Returns the ejb-ql
element
* @return the node defined for the element ejb-ql
*/
public String getEjbQl();
/**
* Removes the ejb-ql
element
* @return the current instance of QueryType
*/
public QueryType removeEjbQl();
// --------------------------------------------------------------------------------------------------------||
// ClassName: QueryType 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 QueryType
*/
public QueryType 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 QueryType
*/
public QueryType removeId();
}