NotifyCommand

Inherits from: framework.Command

An Command for notifying a Listener.

Method Summary
public NotifyCommand	init(Listener listener, string method, string resultKey, string resultArg) Used by the framework for initialization.
public boolean	execute(Event event, EventContext eventContext) Executes the command.
private Listener	getListener()
private string	getMethod()
private string	getResultArg()
private string	getResultKey()
private boolean	hasResultArg()
private boolean	hasResultKey()
private void	setListener(Listener listener)
private void	setMethod(string method)
private void	setResultArg(string resultArg)
private void	setResultKey(string resultKey)

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

getResultArg

private string getResultArg( )

Parameters:

Code:

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

getResultKey

private string getResultKey( )

Parameters:

Code:

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

hasResultArg

private boolean hasResultArg( )

Parameters:

Code:

	<cffunction name="hasResultArg" access="private" returntype="boolean" output="false">
		<cfreturn variables.resultArg NEQ '' />
	</cffunction>

hasResultKey

private boolean hasResultKey( )

Parameters:

Code:

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

init

public NotifyCommand init( Listener listener, string method, string resultKey, string resultArg )

Used by the framework for initialization.

Parameters:
Listener listener
string method
string resultKey
string resultArg

Code:

	<cffunction name="init" access="public" returntype="NotifyCommand" output="false"
		hint="Used by the framework for initialization.">
		<cfargument name="listener" type="MachII.framework.Listener" required="true" />
		<cfargument name="method" type="string" required="true" />
		<cfargument name="resultKey" type="string" required="true" />
		<cfargument name="resultArg" type="string" required="true" />
		
		<cfset setListener(arguments.listener) />
		<cfset setMethod(arguments.method) />
		<cfset setResultKey(arguments.resultKey) />
		<cfset setResultArg(arguments.resultArg) />
		
		<cfreturn this />
	</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>

setResultArg

private void setResultArg( string resultArg )

Parameters:
string resultArg

Code:

	<cffunction name="setResultArg" access="private" returntype="void" output="false">
		<cfargument name="resultArg" type="string" required="true" />
		<cfset variables.resultArg = arguments.resultArg />
	</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>