|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.apache.cayenne.map.Procedure
public class Procedure
A mapping descriptor for a database stored procedure.
| Field Summary | |
|---|---|
protected java.util.List |
callParameters
|
protected java.lang.String |
catalog
|
protected DataMap |
dataMap
|
protected java.lang.String |
name
|
protected boolean |
returningValue
|
protected java.lang.String |
schema
|
| Constructor Summary | |
|---|---|
Procedure()
Creates an unnamed procedure object. |
|
Procedure(java.lang.String name)
Creates a named Procedure object. |
|
| Method Summary | |
|---|---|
void |
addCallParameter(ProcedureParameter param)
Adds new call parameter to the stored procedure. |
void |
clearCallParameters()
|
void |
encodeAsXML(XMLEncoder encoder)
Prints itself as XML to the provided XMLEncoder. |
java.util.List |
getCallOutParameters()
Returns a list of OUT and INOUT call parameters. |
java.util.List |
getCallParameters()
Returns an unmodifiable list of call parameters. |
java.lang.String |
getCatalog()
|
DataMap |
getDataMap()
|
java.lang.String |
getFullyQualifiedName()
Returns procedure name including schema, if present. |
java.lang.String |
getName()
Returns the name property of this object. |
java.lang.Object |
getParent()
Returns the parent map. |
ProcedureParameter |
getResultParam()
Returns parameter describing the return value of the StoredProcedure, or null if procedure does not support return values. |
java.lang.String |
getSchema()
|
boolean |
isReturningValue()
Returns true if a stored procedure returns a value. |
void |
removeCallParameter(java.lang.String name)
Removes a named call parameter. |
void |
setCallParameters(java.util.List parameters)
|
void |
setCatalog(java.lang.String string)
Sets stored procedure's catalog. |
void |
setDataMap(DataMap dataMap)
Sets parent DataMap of this entity. |
void |
setName(java.lang.String name)
|
void |
setParent(java.lang.Object parent)
Stores the parent map. |
void |
setReturningValue(boolean returningValue)
|
void |
setSchema(java.lang.String string)
Sets stored procedure's database schema. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected java.lang.String name
protected DataMap dataMap
protected java.lang.String catalog
protected java.lang.String schema
protected boolean returningValue
protected java.util.List callParameters
| Constructor Detail |
|---|
public Procedure()
public Procedure(java.lang.String name)
| Method Detail |
|---|
public java.lang.String getName()
CayenneMapEntry
getName in interface CayenneMapEntrypublic void setName(java.lang.String name)
public java.lang.Object getParent()
CayenneMapEntry
getParent in interface CayenneMapEntrypublic void setParent(java.lang.Object parent)
CayenneMapEntry
setParent in interface CayenneMapEntrypublic void encodeAsXML(XMLEncoder encoder)
encodeAsXML in interface XMLSerializablepublic java.lang.String getFullyQualifiedName()
public DataMap getDataMap()
public void setDataMap(DataMap dataMap)
public void setCallParameters(java.util.List parameters)
public void addCallParameter(ProcedureParameter param)
param's
parent to be this procedure.
public void removeCallParameter(java.lang.String name)
public void clearCallParameters()
public java.util.List getCallParameters()
public java.util.List getCallOutParameters()
public ProcedureParameter getResultParam()
public boolean isReturningValue()
true if a stored procedure returns a value. The first
parameter in a list of parameters will be assumed to be a descriptor of return
value.
public void setReturningValue(boolean returningValue)
public java.lang.String getCatalog()
public java.lang.String getSchema()
public void setCatalog(java.lang.String string)
public void setSchema(java.lang.String string)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||