|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ojb.broker.metadata.DescriptorBase
org.apache.ojb.broker.metadata.ProcedureDescriptor
A ProcedureDescriptor contains information that is common for all types
of procedures/functions that are used to handle the persistence operations.
Note: Be careful when use ProcedureDescriptor variables or caching
ProcedureDescriptor instances, because instances could become invalid
during runtime (see MetadataManager
).
Constructor Summary | |
ProcedureDescriptor(ClassDescriptor classDescriptor,
java.lang.String name)
Constructor declaration |
Method Summary | |
void |
addAttribute(java.lang.String attributeName,
java.lang.String attributeValue)
Store the specified attribute and it's value. |
int |
getArgumentCount()
Retrieves the number of arguments that are passed to the procedure that this descriptor represents. |
java.util.Collection |
getArguments()
Get the argument descriptors for this procedure. |
java.lang.String |
getAttribute(java.lang.String attributeName)
Get the value of an attribute |
java.lang.String |
getAttribute(java.lang.String attributeName,
java.lang.String defaultValue)
Get the value of an attribute |
ClassDescriptor |
getClassDescriptor()
Retrieve the class descriptor that this object is related to. |
java.lang.String |
getName()
Retrieve the the name of the procedure/function to invoke. |
FieldDescriptor |
getReturnValueFieldRef()
Retrieve the field descriptor that will receive the return value from the procedure/function... |
java.lang.String |
getReturnValueFieldRefName()
Retrieve the name of the field descriptor that will receive the return value from the procedure/function... |
boolean |
hasReturnValue()
Is there a return value for this procedure? |
boolean |
hasReturnValues()
Does this procedure return any values to the 'caller'? |
void |
setReturnValueFieldRef(FieldDescriptor fieldDescriptor)
Change the the field descriptor that will receive the return value from the procedure/function... |
void |
setReturnValueFieldRef(java.lang.String fieldName)
Change the field descriptor that will receive the return value from the procedure/function.. |
java.lang.String |
toString()
|
abstract java.lang.String |
toXML()
|
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public ProcedureDescriptor(ClassDescriptor classDescriptor, java.lang.String name)
Method Detail |
public final java.lang.String getName()
public final void setReturnValueFieldRef(java.lang.String fieldName)
fieldName
- the name of the field that will receive the
return value from the procedure/function.public final void setReturnValueFieldRef(FieldDescriptor fieldDescriptor)
fieldDescriptor
- the field descriptor that will receive the
return value from the procedure/function.public final FieldDescriptor getReturnValueFieldRef()
public final boolean hasReturnValue()
true
if there is a return value for this
procedure.public final boolean hasReturnValues()
true
if the procedure returns at least 1
value that is returned to the caller.public final java.lang.String getReturnValueFieldRefName()
public final ClassDescriptor getClassDescriptor()
public abstract java.lang.String toXML()
public final java.util.Collection getArguments()
public final int getArgumentCount()
Note: The value returned by this method does not reflect the presence of any return value for the procedure
public void addAttribute(java.lang.String attributeName, java.lang.String attributeValue)
AttributeContainer
addAttribute
in interface AttributeContainer
attributeName
- the name of the attribute to retrieveattributeValue
- the attribute's valueAttributeContainer.addAttribute(String, String)
public java.lang.String getAttribute(java.lang.String attributeName, java.lang.String defaultValue)
AttributeContainer
getAttribute
in interface AttributeContainer
attributeName
- the attribute to retrievedefaultValue
- the value to return if the attribute is not present
AttributeContainer.getAttribute(String, String)
public java.lang.String getAttribute(java.lang.String attributeName)
AttributeContainer
getAttribute
in interface AttributeContainer
attributeName
- the attribute to retrieve
AttributeContainer.getAttribute(String)
public java.lang.String toString()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |