org.apache.openejb.jee.was.v6.ejb
Class Query

java.lang.Object
  extended by org.apache.openejb.jee.was.v6.ejb.Query

public class Query
extends Object

The query element is used to specify 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; a specification of the return type mapping, if any, if the query is for a select method; and 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.

Java class for Query complex type.

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

 <complexType name="Query">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="queryMethod" type="{ejb.xmi}QueryMethod"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element name="descriptions" type="{common.xmi}Description"/>
         </choice>
         <choice maxOccurs="unbounded" minOccurs="0">
           <element ref="{http://www.omg.org/XMI}Extension"/>
         </choice>
       </choice>
       <attGroup ref="{http://www.omg.org/XMI}ObjectAttribs"/>
       <attribute name="description" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="ejbQL" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="returnTypeMapping" type="{ejb.xmi}ReturnTypeMapping" />
       <attribute ref="{http://www.omg.org/XMI}id"/>
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  String description
           
protected  List<Description> descriptions
           
protected  String ejbQL
           
protected  List<Extension> extensions
           
protected  String href
           
protected  String id
           
protected  Object idref
           
protected  String label
           
protected  List<QueryMethod> queryMethods
           
protected  ReturnTypeMappingEnum returnTypeMapping
           
protected  QName type
           
protected  String uuid
           
protected  String version
           
 
Constructor Summary
Query()
           
 
Method Summary
 String getDescription()
          Gets the value of the description property.
 List<Description> getDescriptions()
          Gets the value of the descriptions property.
 String getEjbQL()
          Gets the value of the ejbQL property.
 List<Extension> getExtensions()
          Gets the value of the extensions property.
 String getHref()
          Gets the value of the href property.
 String getId()
          Gets the value of the id property.
 Object getIdref()
          Gets the value of the idref property.
 String getLabel()
          Gets the value of the label property.
 List<QueryMethod> getQueryMethods()
          Gets the value of the queryMethods property.
 ReturnTypeMappingEnum getReturnTypeMapping()
          Gets the value of the returnTypeMapping property.
 QName getType()
          Gets the value of the type property.
 String getUuid()
          Gets the value of the uuid property.
 String getVersion()
          Gets the value of the version property.
 void setDescription(String value)
          Sets the value of the description property.
 void setEjbQL(String value)
          Sets the value of the ejbQL property.
 void setHref(String value)
          Sets the value of the href property.
 void setId(String value)
          Sets the value of the id property.
 void setIdref(Object value)
          Sets the value of the idref property.
 void setLabel(String value)
          Sets the value of the label property.
 void setReturnTypeMapping(ReturnTypeMappingEnum value)
          Sets the value of the returnTypeMapping property.
 void setType(QName value)
          Sets the value of the type property.
 void setUuid(String value)
          Sets the value of the uuid property.
 void setVersion(String value)
          Sets the value of the version property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

queryMethods

protected List<QueryMethod> queryMethods

descriptions

protected List<Description> descriptions

extensions

protected List<Extension> extensions

description

protected String description

ejbQL

protected String ejbQL

returnTypeMapping

protected ReturnTypeMappingEnum returnTypeMapping

id

protected String id

type

protected QName type

version

protected String version

href

protected String href

idref

protected Object idref

label

protected String label

uuid

protected String uuid
Constructor Detail

Query

public Query()
Method Detail

getQueryMethods

public List<QueryMethod> getQueryMethods()
Gets the value of the queryMethods property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the queryMethods property.

For example, to add a new item, do as follows:

 getQueryMethods().add(newItem);
 

Objects of the following type(s) are allowed in the list QueryMethod


getDescriptions

public List<Description> getDescriptions()
Gets the value of the descriptions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the descriptions property.

For example, to add a new item, do as follows:

 getDescriptions().add(newItem);
 

Objects of the following type(s) are allowed in the list Description


getExtensions

public List<Extension> getExtensions()
Gets the value of the extensions property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the extensions property.

For example, to add a new item, do as follows:

 getExtensions().add(newItem);
 

Objects of the following type(s) are allowed in the list Extension


getDescription

public String getDescription()
Gets the value of the description property.

Returns:
possible object is String

setDescription

public void setDescription(String value)
Sets the value of the description property.

Parameters:
value - allowed object is String

getEjbQL

public String getEjbQL()
Gets the value of the ejbQL property.

Returns:
possible object is String

setEjbQL

public void setEjbQL(String value)
Sets the value of the ejbQL property.

Parameters:
value - allowed object is String

getReturnTypeMapping

public ReturnTypeMappingEnum getReturnTypeMapping()
Gets the value of the returnTypeMapping property.

Returns:
possible object is ReturnTypeMappingEnum

setReturnTypeMapping

public void setReturnTypeMapping(ReturnTypeMappingEnum value)
Sets the value of the returnTypeMapping property.

Parameters:
value - allowed object is ReturnTypeMappingEnum

getId

public String getId()
Gets the value of the id property.

Returns:
possible object is String

setId

public void setId(String value)
Sets the value of the id property.

Parameters:
value - allowed object is String

getType

public QName getType()
Gets the value of the type property.

Returns:
possible object is QName

setType

public void setType(QName value)
Sets the value of the type property.

Parameters:
value - allowed object is QName

getVersion

public String getVersion()
Gets the value of the version property.

Returns:
possible object is String

setVersion

public void setVersion(String value)
Sets the value of the version property.

Parameters:
value - allowed object is String

getHref

public String getHref()
Gets the value of the href property.

Returns:
possible object is String

setHref

public void setHref(String value)
Sets the value of the href property.

Parameters:
value - allowed object is String

getIdref

public Object getIdref()
Gets the value of the idref property.

Returns:
possible object is Object

setIdref

public void setIdref(Object value)
Sets the value of the idref property.

Parameters:
value - allowed object is Object

getLabel

public String getLabel()
Gets the value of the label property.

Returns:
possible object is String

setLabel

public void setLabel(String value)
Sets the value of the label property.

Parameters:
value - allowed object is String

getUuid

public String getUuid()
Gets the value of the uuid property.

Returns:
possible object is String

setUuid

public void setUuid(String value)
Sets the value of the uuid property.

Parameters:
value - allowed object is String


Copyright © 1999-2013 The Apache OpenEJB development community. All Rights Reserved.