EventMappingCommand

An EventCommand for setting up an event mapping for an event handler.

Method Summary
public void	init(string eventName, string mappingName)
public boolean	execute(Event event, EventContext eventContext)
private string	getEventName()
private string	getMappingName()
private void	setEventName(string eventName)
private void	setMappingName(string mappingName)

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

Method Detail

execute

public boolean execute( Event event, EventContext eventContext )

Parameters:
Event event
EventContext eventContext

Code:

	<cffunction name="execute" access="public" returntype="boolean">
		<cfargument name="event" type="MachII.framework.Event" required="true" />
		<cfargument name="eventContext" type="MachII.framework.EventContext" required="true" />
		
		<cfset arguments.eventContext.setEventMapping(getEventName(), getMappingName()) />
		
		<cfreturn true />
	</cffunction>

getEventName

private string getEventName( )

Parameters:

Code:

	<cffunction name="getEventName" access="private" returntype="string" output="false">
		<cfreturn variables.eventName />
	</cffunction>

getMappingName

private string getMappingName( )

Parameters:

Code:

	<cffunction name="getMappingName" access="private" returntype="string" output="false">
		<cfreturn variables.mappingName />
	</cffunction>

init

public void init( string eventName, string mappingName )

Parameters:
string eventName
string mappingName

Code:

	<cffunction name="init" access="public" returntype="void" output="false">
		<cfargument name="eventName" type="string" required="true" />
		<cfargument name="mappingName" type="string" required="true" />
		
		<cfset setEventName(arguments.eventName) />
		<cfset setMappingName(arguments.mappingName) />
	</cffunction>

setEventName

private void setEventName( string eventName )

Parameters:
string eventName

Code:

	<cffunction name="setEventName" access="private" returntype="void" output="false">
		<cfargument name="eventName" type="string" required="true" />
		<cfset variables.eventName = arguments.eventName />
	</cffunction>

setMappingName

private void setMappingName( string mappingName )

Parameters:
string mappingName

Code:

	<cffunction name="setMappingName" access="private" returntype="void" output="false">
		<cfargument name="mappingName" type="string" required="true" />
		<cfset variables.mappingName = arguments.mappingName />
	</cffunction>