com.metamatrix.metadata.runtime.api
Interface Procedure

All Superinterfaces:

MetadataObject, java.io.Serializable

All Known Implementing Classes:

BasicProcedure

public interface Procedure
extends MetadataObject

Instances of this interface represent Procedures in a Model. The values of a Procedure are analogous to a Stored Procedure or Function in a database.

Method Summary

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	returnsResults() Returns a boolean indicating if this procedure returns a result set.

Methods inherited from interface com.metamatrix.metadata.runtime.api.MetadataObject

clone, compareTo, equals, getFullName, getID, getName, getProperties, getVirtualDatabaseID, toString

Method Detail

getPath

java.lang.String getPath()

Return the path to the procedure.

Returns:

String

getDescription

java.lang.String getDescription()

Return the procedure description.

Returns:

String

getAlias

java.lang.String getAlias()

Return the alias.

Returns:

String alias

getParameters

java.util.List getParameters()

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

Returns:

List of ProcedureParameters

See Also:

ProcedureParameter

returnsResults

boolean returnsResults()

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

Returns:

boolean is true if a result will be returned

getQueryPlan

java.lang.String getQueryPlan()

Returns the queryPlan.

Returns:

String

getProcedureType

short getProcedureType()

Return short indicating the type of procedure.

Returns:

short

See Also:

MetadataConstants.PROCEDURE_TYPES