EventInvoker

Package: MachII.framework.invokers
Inherits from: framework.ListenerInvoker
ListenerInvoker that invokes a Listener's method passing the Event as the sole argument.

<!--- License: Copyright 2006 Mach-II Corporation Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Copyright: Mach-II Corporation Author: Ben Edwards (ben@ben-edwards.com) $Id: EventInvoker.cfc 4352 2006-08-29 20:35:15Z pfarrell $ Created version: 1.1.0 Updated version: 1.1.1 Notes: - Added error handling if notified listener method returns void, but a ResultArg/Key has been defined. This also fixed the problem if the listener returns a Java null value. (pfarrell) --->

Method Summary
public EventInvoker init()

Used by the framework for initialization. Do not override.

public void invokeListener(Event event, Listener listener, string method, [string resultKey=""], [string resultArg=""])

Invokes the Listener.

Method Detail
init

public EventInvoker init( )

Used by the framework for initialization. Do not override.

Parameters:

Code: 

	<cffunction name="init" access="public" returntype="EventInvoker" output="false"
		hint="Used by the framework for initialization. Do not override.">
		<cfreturn this />
	</cffunction>

invokeListener

public void invokeListener( Event event, Listener listener, string method, [string resultKey=""], [string resultArg=""] )

Invokes the Listener.

Parameters:
Event event
Listener listener
string method
[string resultKey=""]
[string resultArg=""]

Code: 

	<cffunction name="invokeListener" access="public" returntype="void"
		hint="Invokes the Listener.">
		<cfargument name="event" type="MachII.framework.Event" required="true"
			hint="The Event triggering the invocation." />
		<cfargument name="listener" type="MachII.framework.Listener" required="true"
			hint="The Listener to invoke." />
		<cfargument name="method" type="string" required="true"
			hint="The name of the Listener's method to invoke." />
		<cfargument name="resultKey" type="string" required="false" default=""
			hint="The variable to set the result in." />
		<cfargument name="resultArg" type="string" required="false" default=""
			hint="The eventArg to set the result in." />
		
		<cfset var resultValue = "" />
		<cftry>
			<cfinvoke 
				component="#arguments.listener#" 
				method="#arguments.method#" 
				event="#arguments.event#" 
				returnvariable="resultValue" />
			
			
			<cfif arguments.resultKey NEQ ''>
				<cfset "#arguments.resultKey#" = resultValue />
			</cfif>
			
			<cfif arguments.resultArg NEQ ''>
				<cfset arguments.event.setArg(arguments.resultArg, resultValue) />
			</cfif>

			<cfcatch type="expression">
				<cfif FindNoCase("RESULTVALUE", cfcatch.Message)>
					<cfthrow type="MachII.framework.VoidReturnType"
							message="A ResultArg/Key has been specified on a notify command method that is returning void. This can also happen if your listener method returns a Java null."
							detail="Notify method name: '#arguments.method#'" />
				<cfelse>
					<cfrethrow />
				</cfif>
			</cfcatch>
			<cfcatch type="Any">
				<cfrethrow />
			</cfcatch>
		</cftry>
	</cffunction>