com.metamatrix.metadata.runtime.model
Class BasicProcedure

java.lang.Object
  com.metamatrix.metadata.runtime.model.BasicMetadataObject
      com.metamatrix.metadata.runtime.model.BasicProcedure

All Implemented Interfaces:

MetadataObject, Procedure, java.io.Serializable

public class BasicProcedure
extends BasicMetadataObject
implements Procedure

See Also:

Serialized Form

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

BasicProcedure

public 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 Detail

getPath

public java.lang.String getPath()

Description copied from interface: Procedure

Return the path to the procedure.

Specified by:

getPath in interface Procedure

Overrides:

getPath in class BasicMetadataObject

Returns:

String

getDescription

public java.lang.String getDescription()

Description copied from interface: Procedure

Return the procedure description.

Specified by:

getDescription in interface Procedure

Returns:

String

getAlias

public java.lang.String getAlias()

Description copied from interface: Procedure

Return the alias.

Specified by:

getAlias in interface Procedure

Overrides:

getAlias in class BasicMetadataObject

Returns:

String alias

setAlias

public void setAlias(java.lang.String alias)

getParameters

public java.util.List getParameters()

Description copied from interface: Procedure

Returns an ordered list of type ProcedureParameter that represent all the parameters the procedure has.

Specified by:

getParameters in interface Procedure

Returns:

List of ProcedureParameters

See Also:

ProcedureParameter

addParameter

public void addParameter(ProcedureParameter pp)

returnsResults

public boolean returnsResults()

Description copied from interface: Procedure

Returns a boolean indicating if this procedure returns a result set.

Specified by:

returnsResults in interface Procedure

Returns:

boolean is true if a result will be returned

getProcedureType

public short getProcedureType()

Description copied from interface: Procedure

Return short indicating the type of procedure.

Specified by:

getProcedureType in interface Procedure

Returns:

short

See Also:

MetadataConstants.PROCEDURE_TYPES

setDescription

public void setDescription(java.lang.String description)

setPath

public void setPath(java.lang.String path)

setParameters

public void setParameters(java.util.List params)

setReturnsResults

public void setReturnsResults(boolean returnsResults)

setProcedureType

public void setProcedureType(short type)

getQueryPlan

public java.lang.String getQueryPlan()

Returns the queryPlan.

Specified by:

getQueryPlan in interface Procedure

Returns:

String

setQueryPlan

public void setQueryPlan(java.lang.String queryPlan)

Sets the queryPlan.

Parameters:

queryPlan - The queryPlan to set

isStoredQuery

public boolean isStoredQuery()