com.wrq.apptrieve.appconn
Class ProcedureMetaData

java.lang.Object
  extended by com.wrq.apptrieve.appconn.ProcedureMetaData
All Implemented Interfaces:
AppConnMetaData

public class ProcedureMetaData
extends java.lang.Object
implements AppConnMetaData

Provides metadata about a procedure that is defined on a table of a Host Integrator model.


Field Summary
static int PROC_TYPE_DELETE
          Return value of getType() when procedure type is Delete.
static int PROC_TYPE_INSERT
          Return value of getType() when procedure type is Insert.
static int PROC_TYPE_SELECT
          Return value of getType() when procedure type is Select.
static int PROC_TYPE_UPDATE
          Return value of getType() when procedure type is Update.
 
Fields inherited from interface com.wrq.apptrieve.appconn.AppConnMetaData
METADATA_TYPE_ATTRIBUTE, METADATA_TYPE_COLUMN, METADATA_TYPE_FIELD, METADATA_TYPE_OPERATION, METADATA_TYPE_PROCEDURE, METADATA_TYPE_RECORDSET, METADATA_TYPE_VARIABLE
 
Constructor Summary
ProcedureMetaData(com.wrq.apptrieve.agent.TableProcedureMeta saObject, java.util.Locale locale)
          Constructor for internal use only.
 
Method Summary
 java.lang.String getDescription()
          Gets the description for the procedure.
 java.util.Set getFilterColumns()
          Gets the filter columns of the procedure.
 java.util.Set getInputColumns()
          Gets the input columns of the procedure.
 int getMetaDataType()
          Gets the meta data type for this object.
 java.lang.String getName()
          Gets the name of the procedure.
 java.util.List getOutputColumns()
          Gets the output columns of the procedure.
 int getType()
          Gets the type of the procedure.
 boolean isRequiredFilter(java.lang.String colName)
          Discovers whether a filter column is required for the procedure.
 boolean isRequiredInput(java.lang.String colName)
          Discovers whether an input column is required for the procedure.
 java.lang.String toString()
          Generates a String object that represents the current values of this ProcedureMetaData object.
 boolean useForSQL()
          Discovers whether this procedure is used for SQL processing.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

PROC_TYPE_DELETE

public static final int PROC_TYPE_DELETE
Return value of getType() when procedure type is Delete.

See Also:
Constant Field Values

PROC_TYPE_UPDATE

public static final int PROC_TYPE_UPDATE
Return value of getType() when procedure type is Update.

See Also:
Constant Field Values

PROC_TYPE_SELECT

public static final int PROC_TYPE_SELECT
Return value of getType() when procedure type is Select.

See Also:
Constant Field Values

PROC_TYPE_INSERT

public static final int PROC_TYPE_INSERT
Return value of getType() when procedure type is Insert.

See Also:
Constant Field Values
Constructor Detail

ProcedureMetaData

public ProcedureMetaData(com.wrq.apptrieve.agent.TableProcedureMeta saObject,
                         java.util.Locale locale)
Constructor for internal use only.

Parameters:
saObject - data
locale - locale
Method Detail

getDescription

public java.lang.String getDescription()
Gets the description for the procedure.

Specified by:
getDescription in interface AppConnMetaData
Returns:
String the description

getFilterColumns

public java.util.Set getFilterColumns()
Gets the filter columns of the procedure. Returns a Set of size 0 if the procedure doesn't have filters.

Returns:
Set a Set of Strings that are the names of the filter columns

getInputColumns

public java.util.Set getInputColumns()
Gets the input columns of the procedure. Returns a Set of size 0 if the procedure doesn't have inputs.

Returns:
Set a Set of Strings that are the names of the input columns

getMetaDataType

public int getMetaDataType()
Gets the meta data type for this object.

Specified by:
getMetaDataType in interface AppConnMetaData
Returns:
int - always returns AppConnMetaData.METADATA_TYPE_PROCEDURE

getName

public java.lang.String getName()
Gets the name of the procedure.

Specified by:
getName in interface AppConnMetaData
Returns:
String the name

getOutputColumns

public java.util.List getOutputColumns()
Gets the output columns of the procedure. Returns a List of size 0 if the procedure doesn't have outputs.

Returns:
List a List of Strings that are the output column names

getType

public int getType()
Gets the type of the procedure.

The returned value is one of:

Returns:
int - the procedure type

isRequiredFilter

public boolean isRequiredFilter(java.lang.String colName)
                         throws AppConnException
Discovers whether a filter column is required for the procedure.

Parameters:
colName - java.lang.String - the name of the filter column to check
Returns:
boolean
Throws:
AppConnException - - If the column name parameter is NULL, or an empty string, or if the named column is not present.

isRequiredInput

public boolean isRequiredInput(java.lang.String colName)
                        throws AppConnException
Discovers whether an input column is required for the procedure.

Parameters:
colName - java.lang.String - the name of the input column to check
Returns:
boolean
Throws:
AppConnException - - If the column name parameter is NULL, or an empty string, or if the named column is not present.

toString

public java.lang.String toString()
Generates a String object that represents the current values of this ProcedureMetaData object.

Overrides:
toString in class java.lang.Object
Returns:
java.lang.String - the string representation of this object

useForSQL

public boolean useForSQL()
Discovers whether this procedure is used for SQL processing. This corresponds to the "Available for SQL Queries" checkbox in the Design Tool Tables dialog.

Returns:
boolean true if the procedure is used for SQL processing