|
Oracle Application Server TopLink API Reference 10g Release 2 (10.1.2) B15903-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.toplink.tools.ejb11.BeanInformationDefinition
oracle.toplink.tools.ejb11.FinderDefinition
Field Summary | |
java.lang.String |
cacheUsage Options for a particular finder may be null (left unset) |
static java.lang.String |
EXPRESSION |
java.lang.String |
finderQuery |
java.lang.String |
finderType |
java.lang.String |
methodName |
java.util.Vector |
methodParamNames |
java.util.Vector |
methodParamTypes |
static java.lang.String |
NAMED |
static java.lang.String |
READALL |
static java.lang.String |
READOBJECT |
static java.lang.String |
REDIRECT |
java.lang.Boolean |
refreshCache |
static java.lang.String |
SQL |
Constructor Summary | |
FinderDefinition() |
|
FinderDefinition(org.w3c.dom.Element finderElem) |
|
FinderDefinition(java.lang.String mthName, java.lang.String fndrType, java.lang.String fndrQuery) |
Method Summary | |
void |
addParameterTypeAndName(java.lang.String type, java.lang.String name) Add a parameter (type,name) pair to the this finder. |
java.lang.String |
getCacheUsage() Return the String that represents the cache usage level for queries. |
org.w3c.dom.Element |
getFinderElement() |
java.lang.String |
getFinderQuery() |
java.lang.String |
getFinderType() |
java.lang.String |
getMethodName() |
java.lang.String |
getMethodNameWithParamTypes() |
java.util.Vector |
getMethodParamNames() |
java.util.Vector |
getMethodParamTypes() |
java.lang.String |
getParameterTypeForName(java.lang.String name) Get the parameter type for the given parameter name. |
java.lang.Boolean |
getRefreshCache() Return the Boolean object that contains true if this attribute has been set and the cache should be refreshed with the results of this query. |
boolean |
hasParameters() |
void |
loadProperties() Precondition: The finderElement has been correctly initialized. |
void |
loadProperties(org.w3c.dom.Element project) |
void |
setCacheUsage(java.lang.String cacheUsageLevel) Set the cache usage level of the finder. |
void |
setFinderQuery(java.lang.String finderQuery) Set the string used for the finder query. |
void |
setFinderType(java.lang.String finderType) Set the type used for the finder query. |
void |
setMethodName(java.lang.String methodName) Set the method name on the home interface. |
void |
setRefreshCache(java.lang.Boolean shouldRefreshCache) Set the refresh cache value of the finder to the Boolean containing true if refreshing is to occur, or false if the cache is not to be refreshed. |
org.w3c.dom.Element |
storeProperties(org.w3c.dom.Document xmlDoc) |
Methods inherited from class oracle.toplink.tools.ejb11.BeanInformationDefinition |
topLink_CMP_DTD |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public java.lang.String methodName
public java.util.Vector methodParamTypes
public java.util.Vector methodParamNames
public java.lang.String finderType
public java.lang.String finderQuery
public java.lang.String cacheUsage
public java.lang.Boolean refreshCache
public static final java.lang.String NAMED
public static final java.lang.String SQL
public static final java.lang.String REDIRECT
public static final java.lang.String EXPRESSION
public static final java.lang.String READOBJECT
public static final java.lang.String READALL
Constructor Detail |
public FinderDefinition()
public FinderDefinition(java.lang.String mthName, java.lang.String fndrType, java.lang.String fndrQuery)
public FinderDefinition(org.w3c.dom.Element finderElem)
Method Detail |
public void addParameterTypeAndName(java.lang.String type, java.lang.String name)
type
- The type of this parameter in the home interface methodname
- The name of this parameter in the home interface methodpublic java.lang.String getCacheUsage()
public org.w3c.dom.Element getFinderElement()
public java.lang.String getFinderQuery()
public java.lang.String getFinderType()
public java.lang.String getMethodName()
public java.lang.String getMethodNameWithParamTypes()
public java.util.Vector getMethodParamNames()
public java.util.Vector getMethodParamTypes()
public java.lang.String getParameterTypeForName(java.lang.String name)
public java.lang.Boolean getRefreshCache()
public boolean hasParameters()
public void loadProperties()
loadProperties
in class BeanInformationDefinition
public void loadProperties(org.w3c.dom.Element project)
loadProperties
in class BeanInformationDefinition
public void setCacheUsage(java.lang.String cacheUsageLevel)
public void setFinderQuery(java.lang.String finderQuery)
finderQuery
- The query String appropriate for the finder typepublic void setFinderType(java.lang.String finderType)
finderType
- A String designating the type of finder. Valid type constants are: NAMED, SQL, REDIRECT, EXPRESSION, READOBJECT, and READALLpublic void setMethodName(java.lang.String methodName)
methodName
- The name of the finder method on the home interfacepublic void setRefreshCache(java.lang.Boolean shouldRefreshCache)
public org.w3c.dom.Element storeProperties(org.w3c.dom.Document xmlDoc)
xmlDoc
- Document
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |