Package com.spotfire.ws.im.ds
Class ProcedureMetadata
- java.lang.Object
-
- com.spotfire.ws.im.ds.MetadataItem
-
- com.spotfire.ws.im.ds.ProcedureMetadata
-
public final class ProcedureMetadata extends MetadataItem
This class represents the database metadata for a stored procedure.- Since:
- 10.1
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ProcedureMetadata.Parameter
This class implements a representation of metadata for an in-parameter for a stored procedure.
-
Field Summary
Fields Modifier and Type Field Description static String
RETURNS_TABLE_ATTR
-
Fields inherited from class com.spotfire.ws.im.ds.MetadataItem
CATALOG, COLUMN, DATA_SOURCE, DATA_TYPE_ATTR, PROCEDURE, PROCEDURE_COLUMN, SCHEMA, TABLE, TABLE_ALIAS, TABLE_REF_ATTR
-
-
Constructor Summary
Constructors Constructor Description ProcedureMetadata(String name, String description, boolean returnsTable, ProcedureMetadata.Parameter[] parameters)
Create a new ProcedureMetadata object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getDescription()
Returns the description.ProcedureMetadata.Parameter[]
getParameters()
Returns the procedure parameters.boolean
getReturnsTable()
Specifies if a table is returned by the procedure.-
Methods inherited from class com.spotfire.ws.im.ds.MetadataItem
create, getAttributeNames, getAttributeValue, getAttributeValues, getName, getType, setAttribute, toString
-
-
-
-
Field Detail
-
RETURNS_TABLE_ATTR
public static final String RETURNS_TABLE_ATTR
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ProcedureMetadata
public ProcedureMetadata(String name, String description, boolean returnsTable, ProcedureMetadata.Parameter[] parameters)
Create a new ProcedureMetadata object.- Parameters:
name
- The name of the procedure.description
- Description text. May be null.returnsTable
- true if the procedure is a table function.parameters
- The in-parameters of the procedure. Null will give an empty list.
-
-
Method Detail
-
getDescription
public String getDescription()
Returns the description.- Returns:
- the procedure description
-
getParameters
public ProcedureMetadata.Parameter[] getParameters()
Returns the procedure parameters.- Returns:
- the parameters
-
getReturnsTable
public boolean getReturnsTable()
Specifies if a table is returned by the procedure.- Returns:
true
if returns a table,false
otherwise
-
-