com.crossingchannels.portal.websphere.specification.jee5.dom

Class QueryType

java.lang.Object

com.crossingchannels.portal.websphere.specification.jee5.dom.QueryType

public class QueryType
extends java.lang.Object

The queryType defines a finder or select query. It contains - an optional description of the query - the specification of the finder or select method it is used by - an optional specification of the result type mapping, if the query is for a select method and entity objects are returned. - the EJB QL query string that defines the query. Queries that are expressible in EJB QL must use the ejb-ql element to specify the query. If a query is not expressible in EJB QL, the description element should be used to describe the semantics of the query and the ejb-ql element should be empty. The result-type-mapping is an optional element. It can only be present if the query-method specifies a select method that returns entity objects. The default value for the result-type-mapping element is "Local".

Java class for queryType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="queryType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="description" type="{http://java.sun.com/xml/ns/javaee}descriptionType" minOccurs="0"/>
         <element name="query-method" type="{http://java.sun.com/xml/ns/javaee}query-methodType"/>
         <element name="result-type-mapping" type="{http://java.sun.com/xml/ns/javaee}result-type-mappingType" minOccurs="0"/>
         <element name="ejb-ql" type="{http://java.sun.com/xml/ns/javaee}xsdStringType"/>
       </sequence>
       <attribute name="id" type="{http://www.w3.org/2001/XMLSchema}ID" />
     </restriction>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field and Description
protected DescriptionType	description
protected XsdStringType	ejbQl
protected java.lang.String	id
protected QueryMethodType	queryMethod
protected ResultTypeMappingType	resultTypeMapping

Constructor Summary

Constructors

Constructor and Description
QueryType()

Method Summary

Methods

Modifier and Type	Method and Description
DescriptionType	getDescription() Gets the value of the description property.
XsdStringType	getEjbQl() Gets the value of the ejbQl property.
java.lang.String	getId() Gets the value of the id property.
QueryMethodType	getQueryMethod() Gets the value of the queryMethod property.
ResultTypeMappingType	getResultTypeMapping() Gets the value of the resultTypeMapping property.
void	setDescription(DescriptionType value) Sets the value of the description property.
void	setEjbQl(XsdStringType value) Sets the value of the ejbQl property.
void	setId(java.lang.String value) Sets the value of the id property.
void	setQueryMethod(QueryMethodType value) Sets the value of the queryMethod property.
void	setResultTypeMapping(ResultTypeMappingType value) Sets the value of the resultTypeMapping property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

description

protected DescriptionType description

queryMethod

protected QueryMethodType queryMethod

resultTypeMapping

protected ResultTypeMappingType resultTypeMapping

ejbQl

protected XsdStringType ejbQl

id

protected java.lang.String id

Constructor Detail

QueryType

public QueryType()

Method Detail

getDescription

public DescriptionType getDescription()

Gets the value of the description property.

Returns:

possible object is DescriptionType

setDescription

public void setDescription(DescriptionType value)

Sets the value of the description property.

Parameters:

value - allowed object is DescriptionType

getQueryMethod

public QueryMethodType getQueryMethod()

Gets the value of the queryMethod property.

Returns:

possible object is QueryMethodType

setQueryMethod

public void setQueryMethod(QueryMethodType value)

Sets the value of the queryMethod property.

Parameters:

value - allowed object is QueryMethodType

getResultTypeMapping

public ResultTypeMappingType getResultTypeMapping()

Gets the value of the resultTypeMapping property.

Returns:

possible object is ResultTypeMappingType

setResultTypeMapping

public void setResultTypeMapping(ResultTypeMappingType value)

Sets the value of the resultTypeMapping property.

Parameters:

value - allowed object is ResultTypeMappingType

getEjbQl

public XsdStringType getEjbQl()

Gets the value of the ejbQl property.

Returns:

possible object is XsdStringType

setEjbQl

public void setEjbQl(XsdStringType value)

Sets the value of the ejbQl property.

Parameters:

value - allowed object is XsdStringType

getId

public java.lang.String getId()

Gets the value of the id property.

Returns:

possible object is String

setId

public void setId(java.lang.String value)

Sets the value of the id property.

Parameters:

value - allowed object is String