public abstract class ProcedureDescriptor
extends java.lang.Object
implements java.io.Serializable
MetadataManager
).Constructor and Description |
---|
ProcedureDescriptor(ClassDescriptor classDescriptor,
java.lang.String name)
Constructor declaration
|
Modifier and Type | Method and Description |
---|---|
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
|
java.lang.String[] |
getAttributeNames()
Returns an array of the names of all atributes of this descriptor.
|
java.util.Map |
getAttributes()
Returns the attribute map (name, value) of this descriptor.
|
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() |
public ProcedureDescriptor(ClassDescriptor classDescriptor, java.lang.String name)
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 presentAttributeContainer.getAttribute(String, String)
public java.lang.String getAttribute(java.lang.String attributeName)
AttributeContainer
getAttribute
in interface AttributeContainer
attributeName
- the attribute to retrieveAttributeContainer.getAttribute(String)
public java.util.Map getAttributes()
public java.lang.String[] getAttributeNames()
null
)public java.lang.String toString()
toString
in class java.lang.Object
(C) 2002 - 2005 Apache Software Foundation
All rights reserved. Published under the Apache License 2.0.
http://db.apache.org/ojb
Version: 1.0.4, 2005-12-30