FilterCommand

Inherits from: framework.Command

An Command for processing an EventFilter.

Method Summary
public FilterCommand	init(EventFilter filter, [struct paramArgs="#StructNew()#"]) Used by the framework for initialization.
public boolean	execute(Event event, EventContext eventContext) Executes the command.
private EventFilter	getFilter()
private struct	getParamArgs()
private void	setFilter(EventFilter filter)
private void	setParamArgs(struct paramArgs)

Methods inherited from framework.Command: setParameter , getParameter , setParameters

Method Detail

execute

public boolean execute( Event event, EventContext eventContext )

Executes the command.

Parameters:
Event event
EventContext eventContext

Code:

	<cffunction name="execute" access="public" returntype="boolean"
		hint="Executes the command.">
		<cfargument name="event" type="MachII.framework.Event" required="true" />
		<cfargument name="eventContext" type="MachII.framework.EventContext" required="true" />
		
		<cfset var continue = false />
		
		<cfinvoke component="#getFilter()#" method="filterEvent" returnVariable="continue">
			<cfinvokeargument name="event" value="#arguments.event#" />
			<cfinvokeargument name="eventContext" value="#arguments.eventContext#" />
			<cfinvokeargument name="paramArgs" value="#getParamArgs()#" />
		</cfinvoke>
		
		<cfreturn continue />
	</cffunction>

getFilter

private EventFilter getFilter( )

Parameters:

Code:

	<cffunction name="getFilter" access="private" returntype="MachII.framework.EventFilter" output="false">
		<cfreturn variables.filter />
	</cffunction>

getParamArgs

private struct getParamArgs( )

Parameters:

Code:

	<cffunction name="getParamArgs" access="private" returntype="struct" output="false">
		<cfreturn variables.paramArgs />
	</cffunction>

init

public FilterCommand init( EventFilter filter, [struct paramArgs="#StructNew()#"] )

Used by the framework for initialization.

Parameters:
EventFilter filter
[struct paramArgs="#StructNew()#"]

Code:

	<cffunction name="init" access="public" returntype="FilterCommand" output="false"
		hint="Used by the framework for initialization.">
		<cfargument name="filter" type="MachII.framework.EventFilter" required="true" />
		<cfargument name="paramArgs" type="struct" required="false" default="#StructNew()#" />
		
		<cfset setFilter(arguments.filter) />
		<cfset setParamArgs(arguments.paramArgs) />
		
		<cfreturn this />
	</cffunction>

setFilter

private void setFilter( EventFilter filter )

Parameters:
EventFilter filter

Code:

	<cffunction name="setFilter" access="private" returntype="void" output="false">
		<cfargument name="filter" type="MachII.framework.EventFilter" required="true" />
		<cfset variables.filter = arguments.filter />
	</cffunction>

setParamArgs

private void setParamArgs( struct paramArgs )

Parameters:
struct paramArgs

Code:

	<cffunction name="setParamArgs" access="private" returntype="void" output="false">
		<cfargument name="paramArgs" type="struct" required="true" />
		<cfset variables.paramArgs = arguments.paramArgs />
	</cffunction>