Oracle Application Server TopLink API Reference
10g Release 2 (10.1.2)

B15903-01


oracle.toplink.tools.ejbjar
Class Query

java.lang.Object
  extended byoracle.toplink.tools.ejbjar.DomObject
      extended byoracle.toplink.tools.ejbjar.Description
          extended byoracle.toplink.tools.ejbjar.Query

All Implemented Interfaces:
EjbJarConstants

public class Query
extends Description

Represents query tag object.


Field Summary
static java.lang.String TL_IMPLEMENTED_EQBQL

Fields inherited from interface oracle.toplink.tools.ejbjar.EjbJarConstants
ABSTRACT_SCHEMA_NAME, ACKNOWLEDGE_MODE, APPLICATION_AUTH, ASSEMBLY_DESCRIPTOR, AUTO_ACKNOWLEDGE, BEAN_MANAGED, BOOLEAN_TYPE, BYTE_TYPE, CASCADE_DELETE, CMP_FIELD, CMP_VERSION, CMP_VERSION_1, CMP_VERSION_2, CMR_FIELD, CMR_FIELD_NAME, CMR_FIELD_TYPE, COLLECTION_TYPE, CONTAINER_AUTH, CONTAINER_MANAGED, CONTAINER_TRANSACTION, DESCRIPTION, DESTINATION_TYPE, DISPLAY_NAME, DOUBLE_TYPE, DUPS_OK_ACKNOWLEDGE, DURABLE, EJB_CLASS, EJB_CLIENT_JAR, EJB_JAR, EJB_LINK, EJB_LOCAL_REF, EJB_NAME, EJB_QL, EJB_REF, EJB_REF_NAME, EJB_REF_TYPE, EJB_RELATION, EJB_RELATION_NAME, EJB_RELATIONSHIP_ROLE, EJB_RELATIONSHIP_ROLE_NAME, ENTERPRISE_BEANS, ENTITY, ENTITY_REF_TYPE, ENV_ENTRY, ENV_ENTRY_NAME, ENV_ENTRY_TYPE, ENV_ENTRY_VALUE, EXCLUDE_LIST, FALSE_VALUE, FIELD_NAME, FLOAT_TYPE, HOME, INTEGER_TYPE, LARGE_ICON, LOCAL, LOCAL_HOME, LONG_TYPE, MANDATORY, MESSAGE_DRIVEN, MESSAGE_DRIVEN_DESTINATION, MESSAGE_SELECTOR, METHOD, METHOD_INTF, METHOD_NAME, METHOD_PARAM, METHOD_PARAMS, METHOD_PERMISSION, MULTIPLICITY, MULTIPLICITY_MANY, MULTIPLICITY_ONE, NEVER, NONDURABLE, NOT_SUPPORTED, PERSISTENCE_TYPE, PRIM_KEY_CLASS, PRIMKEY_FIELD, QUERY, QUERY_METHOD, QUEUE_TYPE, REENTRANT, RELATIONSHIP_ROLE_SOURCE, RELATIONSHIPS, REMOTE, REQUIRED, REQUIRES_NEW, RES_AUTH, RES_REF_NAME, RES_SHARING_SCOPE, RES_TYPE, RESOURCE_ENV_REF, RESOURCE_ENV_REF_NAME, RESOURCE_ENV_REF_TYPE, RESOURCE_REF, RESULT_TYPE_MAPPING, ROLE_LINK, ROLE_NAME, RUN_AS, SECURITY_IDENTITY, SECURITY_ROLE, SECURITY_ROLE_REF, SESSION, SESSION_REF_TYPE, SESSION_TYPE, SET_TYPE, SHAREABLE_SCOPE, SHORT_TYPE, SMALL_ICON, STATEFUL_TYPE, STATELESS_TYPE, STRING_TYPE, SUBSCRIPTION_DURABILITY, SUPPORTS, TOPIC_TYPE, TRANS_ATTRIBUTE, TRANSACTION_TYPE, TRUE_VALUE, UNCHECKED, UNSHAREABLE_SCOPE, USE_CALLER_IDENTITY

Constructor Summary
Query()

Method Summary
java.lang.String getEjbql()
QueryMethod getQueryMethod()
java.lang.String getResultTypeMapping()
java.lang.String getTextValue(org.w3c.dom.Element element)
Return the text value of the given element if it exists Had to override from DomObject to return CDATA
boolean isFinder()
boolean isSelector()
void loadFromElement(org.w3c.dom.Element e)
Load the data for this instance from the specified element.
void setEjbql(java.lang.String ejbql)
void setQueryMethod(QueryMethod queryMeth)
void setResultTypeMapping(java.lang.String resultTypeMapping)
Sets the ResultTypeMapping for ejbSelects
org.w3c.dom.Element toElement(org.w3c.dom.Document doc)
Return the data from this instance as a DOM element.

Methods inherited from class oracle.toplink.tools.ejbjar.Description
getDescription, inheritedFields, setDescription

Methods inherited from class oracle.toplink.tools.ejbjar.DomObject
trace

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TL_IMPLEMENTED_EQBQL

public static final java.lang.String TL_IMPLEMENTED_EQBQL
See Also:
Constant Field Values

Constructor Detail

Query

public Query()

Method Detail

getEjbql

public java.lang.String getEjbql()
Returns:
String the EJBQL String

getQueryMethod

public QueryMethod getQueryMethod()
Returns:
QueryMethod the query method description

getResultTypeMapping

public java.lang.String getResultTypeMapping()
Returns:
ResultTypeMapping the result type mapping for ejbSelects

setResultTypeMapping

public void setResultTypeMapping(java.lang.String resultTypeMapping)
Sets the ResultTypeMapping for ejbSelects

getTextValue

public java.lang.String getTextValue(org.w3c.dom.Element element)
Return the text value of the given element if it exists Had to override from DomObject to return CDATA

isFinder

public boolean isFinder()

isSelector

public boolean isSelector()

setEjbql

public void setEjbql(java.lang.String ejbql)
Parameters:
ejbql - the EJBQL String for this query

setQueryMethod

public void setQueryMethod(QueryMethod queryMeth)
Parameters:
queryMeth - the QueryMethod object

loadFromElement

public void loadFromElement(org.w3c.dom.Element e)
Load the data for this instance from the specified element.
Overrides:
loadFromElement in class Description
Parameters:
e - the DOM element

toElement

public org.w3c.dom.Element toElement(org.w3c.dom.Document doc)
Return the data from this instance as a DOM element.
Specified by:
toElement in class DomObject
Parameters:
doc - a Document instance used to create elements

Copyright © 1998, 2005 Oracle Corporation. All Rights Reserved.