AnnounceCommand

An EventCommand for announcing an event.

Method Summary
public void	init(string eventName, [boolean copyEventArgs="true"])
public boolean	execute(Event event, EventContext eventContext)
private string	getEventName()
private boolean	isCopyEventArgs()
private void	setCopyEventArgs([boolean copyEventArgs="true"])
private void	setEventName(string eventName)

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" output="false">
		<cfargument name="event" type="MachII.framework.Event" required="true" />
		<cfargument name="eventContext" type="MachII.framework.EventContext" required="true" />
		
		<cfset var eventArgs = 0 />
		<cfif isCopyEventArgs()>
			<cfset eventArgs = event.getArgs() />
		<cfelse>
			<cfset eventArgs = StructNew() />
		</cfif>
		
		<cfset arguments.eventContext.announceEvent(getEventName(), eventArgs) />
		
		<cfreturn true />
	</cffunction>

getEventName

private string getEventName( )

Parameters:

Code:

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

init

public void init( string eventName, [boolean copyEventArgs="true"] )

Parameters:
string eventName
[boolean copyEventArgs="true"]

Code:

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

isCopyEventArgs

private boolean isCopyEventArgs( )

Parameters:

Code:

	<cffunction name="isCopyEventArgs" access="private" returntype="boolean" output="false">
		<cfreturn variables.copyEventArgs />
	</cffunction>

setCopyEventArgs

private void setCopyEventArgs( [boolean copyEventArgs="true"] )

Parameters:
[boolean copyEventArgs="true"]

Code:

	<cffunction name="setCopyEventArgs" access="private" returntype="void" output="false">
		<cfargument name="copyEventArgs" type="boolean" required="false" default="true" />
		<cfset variables.copyEventArgs = arguments.copyEventArgs />
	</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>