|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.wrq.apptrieve.appconn.ProcedureMetaData
public class ProcedureMetaData
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(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 |
---|
public static final int PROC_TYPE_DELETE
getType()
when procedure type is Delete.
public static final int PROC_TYPE_UPDATE
getType()
when procedure type is Update.
public static final int PROC_TYPE_SELECT
getType()
when procedure type is Select.
public static final int PROC_TYPE_INSERT
getType()
when procedure type is Insert.
Constructor Detail |
---|
public ProcedureMetaData(TableProcedureMeta saObject, java.util.Locale locale)
saObject
- datalocale
- localeMethod Detail |
---|
public java.lang.String getDescription()
getDescription
in interface AppConnMetaData
public java.util.Set getFilterColumns()
public java.util.Set getInputColumns()
public int getMetaDataType()
getMetaDataType
in interface AppConnMetaData
public java.lang.String getName()
getName
in interface AppConnMetaData
public java.util.List getOutputColumns()
public int getType()
The returned value is one of:
public boolean isRequiredFilter(java.lang.String colName) throws AppConnException
colName
- java.lang.String - the name of the filter column to check
com.wrq.apptrieve.appconn.AppConnException
- - If the column name parameter is NULL, or an empty string, or if the named column is not present.
AppConnException
public boolean isRequiredInput(java.lang.String colName) throws AppConnException
colName
- java.lang.String - the name of the input column to check
com.wrq.apptrieve.appconn.AppConnException
- - If the column name parameter is NULL, or an empty string, or if the named column is not present.
AppConnException
public java.lang.String toString()
toString
in class java.lang.Object
public boolean useForSQL()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |