NotifyCommand

An EventCommand for notifying a Listener.

Method Summary
public void	init(Listener listener, string method, string resultKey)
public boolean	execute(Event event, EventContext eventContext)
private Listener	getListener()
private string	getMethod()
private string	getResultKey()
private boolean	hasResultKey()
private void	setListener(Listener listener)
private void	setMethod(string method)
private void	setResultKey(string resultKey)

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 var listener = getListener() />
		<cfset var invoker = listener.getInvoker() />
		<cfset invoker.invokeListener(arguments.event, listener, getMethod(), getResultKey()) />
		
		<cfreturn true />
	</cffunction>

getListener

private Listener getListener( )

Parameters:

Code:

	<cffunction name="getListener" access="private" returntype="MachII.framework.Listener" output="false">
		<cfreturn variables.listener />
	</cffunction>

getMethod

private string getMethod( )

Parameters:

Code:

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

getResultKey

private string getResultKey( )

Parameters:

Code:

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

hasResultKey

private boolean hasResultKey( )

Parameters:

Code:

	<cffunction name="hasResultKey" access="private" returntype="boolean" output="false">
		<cfreturn NOT getResultKey() IS '' />
	</cffunction>

init

public void init( Listener listener, string method, string resultKey )

Parameters:
Listener listener
string method
string resultKey

Code:

	<cffunction name="init" access="public" returntype="void" output="false">
		<cfargument name="listener" type="MachII.framework.Listener" required="true" />
		<cfargument name="method" type="string" required="true" />
		<cfargument name="resultKey" type="string" required="true" />
		
		<cfset setListener(arguments.listener) />
		<cfset setMethod(arguments.method) />
		<cfset setResultKey(arguments.resultKey) />
	</cffunction>

setListener

private void setListener( Listener listener )

Parameters:
Listener listener

Code:

	<cffunction name="setListener" access="private" returntype="void" output="false">
		<cfargument name="listener" type="MachII.framework.Listener" required="true" />
		<cfset variables.listener = arguments.listener />
	</cffunction>

setMethod

private void setMethod( string method )

Parameters:
string method

Code:

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

setResultKey

private void setResultKey( string resultKey )

Parameters:
string resultKey

Code:

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