org.eclipse.modisco.jee.ejbjar.EjbJar21
Interface QueryType


public interface QueryType

A representation of the model object 'Query Type'. 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".

The following features are supported:

See Also:
EjbJar21Package.getQueryType()
Generated:
Model:
extendedMetaData="name='queryType' kind='elementOnly'"

Method Summary
 DescriptionType getDescription()
          Returns the value of the 'Description' containment reference.
 XsdStringType getEjbQl()
          Returns the value of the 'Ejb Ql' containment reference.
 java.lang.String getId()
          Returns the value of the 'Id' attribute.
 QueryMethodType getQueryMethod()
          Returns the value of the 'Query Method' containment reference.
 ResultTypeMappingType getResultTypeMapping()
          Returns the value of the 'Result Type Mapping' containment reference.
 void setDescription(DescriptionType value)
          Sets the value of the 'Description' containment reference.
 void setEjbQl(XsdStringType value)
          Sets the value of the 'Ejb Ql' containment reference.
 void setId(java.lang.String value)
          Sets the value of the 'Id' attribute.
 void setQueryMethod(QueryMethodType value)
          Sets the value of the 'Query Method' containment reference.
 void setResultTypeMapping(ResultTypeMappingType value)
          Sets the value of the 'Result Type Mapping' containment reference.
 

Method Detail

getDescription

DescriptionType getDescription()
Returns the value of the 'Description' containment reference.

If the meaning of the 'Description' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Description' containment reference.
See Also:
setDescription(DescriptionType), EjbJar21Package.getQueryType_Description()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='description' namespace='http://java.sun.com/xml/ns/j2ee'"

setDescription

void setDescription(DescriptionType value)
Sets the value of the 'Description' containment reference.

Parameters:
value - the new value of the 'Description' containment reference.
See Also:
getDescription()
Generated:

getQueryMethod

QueryMethodType getQueryMethod()
Returns the value of the 'Query Method' containment reference.

If the meaning of the 'Query Method' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Query Method' containment reference.
See Also:
setQueryMethod(QueryMethodType), EjbJar21Package.getQueryType_QueryMethod()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='query-method' namespace='http://java.sun.com/xml/ns/j2ee'"

setQueryMethod

void setQueryMethod(QueryMethodType value)
Sets the value of the 'Query Method' containment reference.

Parameters:
value - the new value of the 'Query Method' containment reference.
See Also:
getQueryMethod()
Generated:

getResultTypeMapping

ResultTypeMappingType getResultTypeMapping()
Returns the value of the 'Result Type Mapping' containment reference.

If the meaning of the 'Result Type Mapping' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Result Type Mapping' containment reference.
See Also:
setResultTypeMapping(ResultTypeMappingType), EjbJar21Package.getQueryType_ResultTypeMapping()
Generated:
Model:
containment="true" extendedMetaData="kind='element' name='result-type-mapping' namespace='http://java.sun.com/xml/ns/j2ee'"

setResultTypeMapping

void setResultTypeMapping(ResultTypeMappingType value)
Sets the value of the 'Result Type Mapping' containment reference.

Parameters:
value - the new value of the 'Result Type Mapping' containment reference.
See Also:
getResultTypeMapping()
Generated:

getEjbQl

XsdStringType getEjbQl()
Returns the value of the 'Ejb Ql' containment reference.

If the meaning of the 'Ejb Ql' containment reference isn't clear, there really should be more of a description here...

Returns:
the value of the 'Ejb Ql' containment reference.
See Also:
setEjbQl(XsdStringType), EjbJar21Package.getQueryType_EjbQl()
Generated:
Model:
containment="true" required="true" extendedMetaData="kind='element' name='ejb-ql' namespace='http://java.sun.com/xml/ns/j2ee'"

setEjbQl

void setEjbQl(XsdStringType value)
Sets the value of the 'Ejb Ql' containment reference.

Parameters:
value - the new value of the 'Ejb Ql' containment reference.
See Also:
getEjbQl()
Generated:

getId

java.lang.String getId()
Returns the value of the 'Id' attribute.

If the meaning of the 'Id' attribute isn't clear, there really should be more of a description here...

Returns:
the value of the 'Id' attribute.
See Also:
setId(String), EjbJar21Package.getQueryType_Id()
Generated:
Model:
id="true" dataType="org.eclipse.emf.ecore.xml.type.ID" extendedMetaData="kind='attribute' name='id'"

setId

void setId(java.lang.String value)
Sets the value of the 'Id' attribute.

Parameters:
value - the new value of the 'Id' attribute.
See Also:
getId()
Generated: