com.wrq.vhi.script.api
Interface ApplyFilterEvent

All Superinterfaces:

EntityEvent, Event, HostSessionEvent, ModelEvent, RecordEvent, RecordSetEvent

public interface ApplyFilterEvent
extends RecordEvent

Apply filter event information.

See Also:

RecordSetEventHandler.applyFilter(com.wrq.vhi.script.api.ApplyFilterEvent)

Method Summary

boolean	defaultApplyFilter() Gets the result of the default evaluation.
java.lang.String	getFilterExpression() Gets the filter expression.
ModelRecord	getRecord() Gets the record to filter.

Methods inherited from interface com.wrq.vhi.script.api.RecordEvent

getHostRecordIndex, getRecordIndex, getRecordStateObject, isRecordStateObject, setRecordStateObject

Methods inherited from interface com.wrq.vhi.script.api.RecordSetEvent

getPageNumber, getRecordSetContext, getRecordSetMetaData, getRecordSetName

Methods inherited from interface com.wrq.vhi.script.api.EntityEvent

getEntityName, getTabStops

Methods inherited from interface com.wrq.vhi.script.api.HostSessionEvent

getHostSession

Methods inherited from interface com.wrq.vhi.script.api.ModelEvent

getClientSession, getCurrentOperation, getCurrentProcedure, getModelContext

Methods inherited from interface com.wrq.vhi.script.api.Event

checkForTimeout, createErrorMessage, createErrorMessage, createHostSession, createUserErrorMessage, getEventStack, getHandlerProperty, getLogger, isDesignEnvironment

Method Detail

getFilterExpression

java.lang.String getFilterExpression()

Gets the filter expression.

Returns:

the filter expression

getRecord

ModelRecord getRecord()

Gets the record to filter.

Returns:

the record to filter

defaultApplyFilter

boolean defaultApplyFilter()
                           throws ApptrieveException

Gets the result of the default evaluation.

Returns:

true if the filter matches

Throws:

ApptrieveException - if the condition cannot be parsed.