|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.metamatrix.metadata.runtime.model.BasicMetadataObject com.metamatrix.metadata.runtime.model.BasicProcedure
public class BasicProcedure
Constructor Summary | |
---|---|
BasicProcedure(BasicProcedureID procedureID,
BasicVirtualDatabaseID virtualDBID)
Call constructor to instantiate a runtime object by passing the RuntimeID that identifies the entity and the VIrtualDatabaseID that identifes the Virtual Database the object will be contained. |
Method Summary | |
---|---|
void |
addParameter(ProcedureParameter pp)
|
java.lang.String |
getAlias()
Return the alias. |
java.lang.String |
getDescription()
Return the procedure description. |
java.util.List |
getParameters()
Returns an ordered list of type ProcedureParameter that represent all the parameters the procedure has. |
java.lang.String |
getPath()
Return the path to the procedure. |
short |
getProcedureType()
Return short indicating the type of procedure. |
java.lang.String |
getQueryPlan()
Returns the queryPlan. |
boolean |
isStoredQuery()
|
boolean |
returnsResults()
Returns a boolean indicating if this procedure returns a result set. |
void |
setAlias(java.lang.String alias)
|
void |
setDescription(java.lang.String description)
|
void |
setParameters(java.util.List params)
|
void |
setPath(java.lang.String path)
|
void |
setProcedureType(short type)
|
void |
setQueryPlan(java.lang.String queryPlan)
Sets the queryPlan. |
void |
setReturnsResults(boolean returnsResults)
|
Methods inherited from class com.metamatrix.metadata.runtime.model.BasicMetadataObject |
---|
addProperty, clone, compareTo, equals, getCurrentProperties, getFullName, getID, getName, getNameInSource, getProperties, getVirtualDatabaseID, hashCode, hasNameInSource, setID, setProperties, toString |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.metamatrix.metadata.runtime.api.MetadataObject |
---|
clone, compareTo, equals, getFullName, getID, getName, getProperties, getVirtualDatabaseID, toString |
Constructor Detail |
---|
public BasicProcedure(BasicProcedureID procedureID, BasicVirtualDatabaseID virtualDBID)
Method Detail |
---|
public java.lang.String getPath()
Procedure
getPath
in interface Procedure
getPath
in class BasicMetadataObject
public java.lang.String getDescription()
Procedure
getDescription
in interface Procedure
public java.lang.String getAlias()
Procedure
getAlias
in interface Procedure
getAlias
in class BasicMetadataObject
public void setAlias(java.lang.String alias)
public java.util.List getParameters()
Procedure
ProcedureParameter
that represent all the parameters the procedure has.
getParameters
in interface Procedure
ProcedureParameter
public void addParameter(ProcedureParameter pp)
public boolean returnsResults()
Procedure
returnsResults
in interface Procedure
public short getProcedureType()
Procedure
getProcedureType
in interface Procedure
MetadataConstants.PROCEDURE_TYPES
public void setDescription(java.lang.String description)
public void setPath(java.lang.String path)
public void setParameters(java.util.List params)
public void setReturnsResults(boolean returnsResults)
public void setProcedureType(short type)
public java.lang.String getQueryPlan()
getQueryPlan
in interface Procedure
public void setQueryPlan(java.lang.String queryPlan)
queryPlan
- The queryPlan to setpublic boolean isStoredQuery()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |