EventFilter

Package: MachII.framework

Inherits from: framework.BaseComponent

Base EventFilter component.

Method Summary
public EventFilter	init(AppManager appManager, [struct parameters="#StructNew()#"]) Used by the framework for initialization. Do not override.
public boolean	filterEvent(Event event, EventContext eventContext, [struct paramArgs="#StructNew()#"]) Override (be sure to keep the same arguments and returntype) to provide event filtering logic.

Methods inherited from framework.BaseComponent: setParameters , hasParameter , buildUrlToModule , isParameterDefined , buildUrl , announceEventInModule , setAppManager , getParameter , getProperty , getParameters , setProperty , getPropertyManager , bindValue , configure , getAppManager , setParameter , announceEvent

Method Detail

filterEvent

public boolean filterEvent( Event event, EventContext eventContext, [struct paramArgs="#StructNew()#"] )

Override (be sure to keep the same arguments and returntype) to provide event filtering logic.

Parameters:
Event event
EventContext eventContext
[struct paramArgs="#StructNew()#"]

Code:

	<cffunction name="filterEvent" access="public" returntype="boolean" output="false"
		hint="Override (be sure to keep the same arguments and returntype) to provide event filtering logic.">
		<cfargument name="event" type="MachII.framework.Event" required="true" />
		<cfargument name="eventContext" type="MachII.framework.EventContext" required="true" />
		<cfargument name="paramArgs" type="struct" required="false" default="#StructNew()#" />
		
		<cfreturn true />
	</cffunction>

init

public EventFilter init( AppManager appManager, [struct parameters="#StructNew()#"] )

Used by the framework for initialization. Do not override.

Parameters:
AppManager appManager
[struct parameters="#StructNew()#"]

Code:

	<cffunction name="init" access="public" returntype="EventFilter" output="false"
		hint="Used by the framework for initialization. Do not override.">
		<cfargument name="appManager" type="MachII.framework.AppManager" required="true" />
		<cfargument name="parameters" type="struct" required="false" default="#StructNew()#" />
		
		<cfset super.init(arguments.appManager, arguments.parameters) />
		
		<cfreturn this />
	</cffunction>