Class Hierarchy    Previous  Next  Index

Interface COM.cloudscape.database.TriggerExecutionContext


public interface TriggerExecutionContext
Copyright © 1998-2000, Informix Software, Inc. All rights reserved.

A trigger execution context holds information that is available from the context of a trigger invocation.

Cloudscape reserves the right to change, rename, or remove this interface at any time.


Variable Index

 o DELETE_EVENT
Return value from getEventType() for a delete trigger.
 o INSERT_EVENT
Return value from getEventType() for an insert trigger.
 o UPDATE_EVENT
Return value from getEventType() for an update trigger.

Method Index

 o getEventStatementText()
Get the text of the statement that caused the trigger to fire.
 o getEventType()
Get the type for the event that caused the trigger to fire.
 o getModifiedColumns()
Get the columns that have been modified by the statement that caused this trigger to fire.
 o getNewRow()
Like getNewRowSet(), but returns a result set positioned on the first row of the after (new) result set.
 o getNewRowSet()
Returns a result set of the new (after) images of the changed rows.
 o getOldRow()
Like getOldRowSet(), but returns a result set positioned on the first row of the before (old) result set.
 o getOldRowSet()
Returns a result set of the old (before) images of the changed rows.
 o getTargetTableId()
Get the target table UUID upon which the trigger event is declared.
 o getTargetTableName()
Get the target table name upon which the trigger event is declared.
 o wasColumnModified(int)
Find out if a column was changed, by column number
 o wasColumnModified(String)
Find out if a column was changed, by column name.

Field Detail

 o UPDATE_EVENT
public static final int UPDATE_EVENT
          Return value from getEventType() for an update trigger.
 o DELETE_EVENT
public static final int DELETE_EVENT
          Return value from getEventType() for a delete trigger.
 o INSERT_EVENT
public static final int INSERT_EVENT
          Return value from getEventType() for an insert trigger.

Method Detail

 o getTargetTableName
public java.lang.String getTargetTableName()
          Get the target table name upon which the trigger event is declared.
Returns:
the target table
 o getTargetTableId
public UUID getTargetTableId()
          Get the target table UUID upon which the trigger event is declared.
Returns:
the uuid of the target table
 o getEventType
public int getEventType()
          Get the type for the event that caused the trigger to fire.
Returns:
the event type (e.g. UPDATE_EVENT)
 o getEventStatementText
public java.lang.String getEventStatementText()
          Get the text of the statement that caused the trigger to fire. For a trigger that is firing on a synchronization source as a result of a target refresh, this will return null.
Returns:
the statement text, or null for a trigger that is firing on a synchronization source due to a target refresh.
 o getModifiedColumns
public java.lang.String[] getModifiedColumns()
          Get the columns that have been modified by the statement that caused this trigger to fire. If all columns are modified, will return null (e.g. for INSERT or DELETE return null).
Returns:
an array of Strings
 o wasColumnModified
public boolean wasColumnModified(java.lang.String columnName)
          Find out if a column was changed, by column name.
Parameters:
columnName - the column to check
Returns:
true if the column was modified by this statement. Note that this will always return true for INSERT and DELETE regardless of the column name passed in.
 o wasColumnModified
public boolean wasColumnModified(int columnNumber)
          Find out if a column was changed, by column number
Parameters:
columnNumber - the column to check
Returns:
true if the column was modified by this statement. Note that this will always return true for INSERT and DELETE regardless of the column name passed in.
 o getOldRowSet
public java.sql.ResultSet getOldRowSet() throws java.sql.SQLException
          Returns a result set of the old (before) images of the changed rows. For a row trigger, this result set will have a single row. For a statement trigger, this result set has every row that has changed or will change. If a statement trigger does not affect a row, then the result set will be empty (i.e. ResultSet.next() will return false).

Will return null if the call is inapplicable for the trigger that is currently executing. For example, will return null if called during a the firing of an INSERT trigger.

Returns:
the ResultSet containing before images of the rows changed by the triggering event. May return null.
Throws:
java.sql.SQLException - if called after the triggering event has completed
 o getNewRowSet
public java.sql.ResultSet getNewRowSet() throws java.sql.SQLException
          Returns a result set of the new (after) images of the changed rows. For a row trigger, this result set will have a single row. For a statement trigger, this result set has every row that has changed or will change. If a statement trigger does not affect a row, then the result set will be empty (i.e. ResultSet.next() will return false).

Will return null if the call is inapplicable for the trigger that is currently executingr. For example, will return null if called during the firing of a DELETE trigger.

Returns:
the ResultSet containing after images of the rows changed by the triggering event. May return null.
Throws:
java.sql.SQLException - if called after the triggering event has completed
 o getOldRow
public java.sql.ResultSet getOldRow() throws java.sql.SQLException
          Like getOldRowSet(), but returns a result set positioned on the first row of the before (old) result set. Used as a convenience to get a column for a row trigger. Equivalent to getOldRowSet() followed by next().

Will return null if the call is inapplicable for the trigger that is currently executing. For example, will return null if called during a the firing of an INSERT trigger.

Returns:
the ResultSet positioned on the old row image. May return null.
Throws:
java.sql.SQLException - if called after the triggering event has completed
 o getNewRow
public java.sql.ResultSet getNewRow() throws java.sql.SQLException
          Like getNewRowSet(), but returns a result set positioned on the first row of the after (new) result set. Used as a convenience to get a column for a row trigger. Equivalent to getNewRowSet() followed by next().

Will return null if the call is inapplicable for the trigger that is currently executingr. For example, will return null if called during the firing of a DELETE trigger.

Returns:
the ResultSet positioned on the new row image. May return null.
Throws:
java.sql.SQLException - if called after the triggering event has completed

  Class Hierarchy    Previous  Next  Index