com.wrq.vhi.script.api
Interface ExecuteProcedureEvent

All Superinterfaces:
Event, HostSessionEvent, ModelEvent

public interface ExecuteProcedureEvent
extends ModelEvent, HostSessionEvent

Execute procedure event information.

See Also:
ProcedureEventHandler.executeProcedure(com.wrq.vhi.script.api.ExecuteProcedureEvent)

Method Summary
 MutableProcedureRecordSet createProcedureRecordSet()
          Create an empty MutableProcedureRecordSet configured with the procedure's outputs as columns.
 MutableProcedureRecordSet defaultProcedure()
          Execute the default procedure implementation with the input parameters returned from getProcedureInputParameters().
 MutableProcedureRecordSet defaultProcedure(ProcedureParameters[] inputs, int maxRows)
          Execute the default procedure implementation with the specified sets of input parameters.
 MutableProcedureRecordSet defaultProcedure(ProcedureParameters input, int maxRows)
          Execute the default procedure implementation with the specified set of input parameters.
 int getMaxRows()
          Gets the maximum number of rows requested.
 ProcedureParameters[] getProcedureInputParameters()
          Gets the procedure's input parameters.
 ProcedureMetaData getProcedureMetaData()
          Gets the metadata for this procedure.
 java.lang.String getProcedureName()
          Gets the procedure name.
 java.lang.String getTableName()
          Gets the table name.
 boolean isCaseSensitive()
          Determine if comparisons should be done case-sensitively.
 
Methods inherited from interface com.wrq.vhi.script.api.HostSessionEvent
getHostSession
 

Method Detail

getTableName

java.lang.String getTableName()
Gets the table name.

Returns:
the name of the table

getProcedureName

java.lang.String getProcedureName()
Gets the procedure name.

Returns:
the name of the procedure

getMaxRows

int getMaxRows()
Gets the maximum number of rows requested.

Returns:
the maximum rows

isCaseSensitive

boolean isCaseSensitive()
Determine if comparisons should be done case-sensitively.

Returns:
true if comparisons should be case-sensitive

getProcedureInputParameters

ProcedureParameters[] getProcedureInputParameters()
Gets the procedure's input parameters. Select, Update and Delete procedures will have only one set of input parameters. Insert procedures, however, can have one or more sets of input parameters.

Returns:
one or more sets of input parameters

defaultProcedure

MutableProcedureRecordSet defaultProcedure()
                                           throws ApptrieveException
Execute the default procedure implementation with the input parameters returned from getProcedureInputParameters().

Returns:
the procedure output recordset if this is a select procedure, otherwise null
Throws:
ApptrieveException - if an error occurs executing the procedure

defaultProcedure

MutableProcedureRecordSet defaultProcedure(ProcedureParameters input,
                                           int maxRows)
                                           throws ApptrieveException
Execute the default procedure implementation with the specified set of input parameters.

Parameters:
input - the procedure input parameters
maxRows - the maximum number of rows to return
Returns:
the procedure output recordset if this is a select procedure, otherwise null
Throws:
ApptrieveException - if an error occurs executing the procedure

defaultProcedure

MutableProcedureRecordSet defaultProcedure(ProcedureParameters[] inputs,
                                           int maxRows)
                                           throws ApptrieveException
Execute the default procedure implementation with the specified sets of input parameters.

Parameters:
inputs -
maxRows -
Returns:
the output recordset if the this is a select procedure, otherwise null
Throws:
ApptrieveException - if an error occurs executing the procedure

createProcedureRecordSet

MutableProcedureRecordSet createProcedureRecordSet()
Create an empty MutableProcedureRecordSet configured with the procedure's outputs as columns.

Returns:
the output record set

getProcedureMetaData

ProcedureMetaData getProcedureMetaData()
                                       throws ApptrieveException
Gets the metadata for this procedure.

Returns:
the metadata for the procedure
Throws:
ApptrieveException - if an error occurs obtaining the metadata