Listener

Package: MachII.framework

Inherits from: framework.BaseComponent

Base Listener component.

Method Summary
public Listener	init(AppManager appManager, [struct parameters="#StructNew()#"], [ListenerInvoker invoker]) Used by the framework for initialization. Do not override.
public any	getInvoker() Gets the ListenerInvoker to use when invoking methods for this Listener.
public void	setInvoker(ListenerInvoker invoker) Sets the ListenerInvoker to use when invoking methods for this Listener.

Methods inherited from framework.BaseComponent: setParameters , hasParameter , buildUrlToModule , isParameterDefined , buildUrl , announceEventInModule , setAppManager , getParameter , getProperty , getParameters , setProperty , getPropertyManager , bindValue , configure , getAppManager , setParameter , announceEvent

Method Detail

getInvoker

public any getInvoker( )

Gets the ListenerInvoker to use when invoking methods for this Listener.

Parameters:

Code:

	<cffunction name="getInvoker" access="public" type="MachII.framework.ListenerInvoker" output="false"
		hint="Gets the ListenerInvoker to use when invoking methods for this Listener.">
		<cfreturn variables.invoker />
	</cffunction>

init

public Listener init( AppManager appManager, [struct parameters="#StructNew()#"], [ListenerInvoker invoker] )

Used by the framework for initialization. Do not override.

Parameters:
AppManager appManager
[struct parameters="#StructNew()#"]
[ListenerInvoker invoker]

Code:

	<cffunction name="init" access="public" returntype="Listener" output="false"
		hint="Used by the framework for initialization. Do not override.">
		<cfargument name="appManager" type="MachII.framework.AppManager" required="true" />
		<cfargument name="parameters" type="struct" required="false" default="#StructNew()#" />
		<cfargument name="invoker" type="MachII.framework.ListenerInvoker" required="false" />
		
		<cfset super.init(arguments.appManager, arguments.parameters) />
		
		<cfif StructKeyExists(arguments, "invoker")>
			<cfset setInvoker(arguments.invoker) />
		</cfif>
		
		<cfreturn this />
	</cffunction>

setInvoker

public void setInvoker( ListenerInvoker invoker )

Sets the ListenerInvoker to use when invoking methods for this Listener.

Parameters:
ListenerInvoker invoker

Code:

	<cffunction name="setInvoker" access="public" returntype="void" output="false"
		hint="Sets the ListenerInvoker to use when invoking methods for this Listener.">
		<cfargument name="invoker" type="MachII.framework.ListenerInvoker" required="true" />
		<cfset variables.invoker = arguments.invoker />
	</cffunction>