public boolean execute( Event event, EventContext eventContext )

Executes the command.

Parameters:

Event event

EventContext eventContext

Code:

	<cffunction name="execute" access="public" returntype="boolean" output="false"
		hint="Executes the command.">
		<cfargument name="event" type="MachII.framework.Event" required="true" />
		<cfargument name="eventContext" type="MachII.framework.EventContext" required="true" />
		
		<cfset var value = "" />
		<cfset var log = getLog() />		

		
		<cfif isArgVariableDefined()>
			<cfset value = getArgVariableValue() />
		<cfelseif isArgValueDefined()>
			<cfset value = getArgValue() />
		</cfif>
		
		
		<cfif getOverwrite() OR NOT arguments.event.isArgDefined(getArgName())>
			<cfif log.isDebugEnabled()>
				<cfif IsSimpleValue(value)>
					<cfset log.debug("Set event-arg named '#getArgName()#' with value '#value#'.") />
				<cfelse>
					<cfset log.debug("Set event-arg named '#getArgName()#'.", value) />
				</cfif>
			</cfif>
			
			<cfset arguments.event.setArg(getArgName(), value) />
		<cfelse>
			<cfif log.isDebugEnabled()>				
				<cfif IsSimpleValue(value)>
					<cfset log.debug("An event-arg named '#getArgName()#' with overwrite 'false' is already defined. Current value or variable: '#value#'.") />
				<cfelse>
					<cfset log.debug("An event-arg named '#getArgName()#' with overwrite 'false' is already defined.", value) />
				</cfif>
			</cfif>
		</cfif>
		
		<cfreturn true />
	</cffunction> 

private string getArgName( )

Parameters:

Code:

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

private string getArgValue( )

Parameters:

Code:

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

private string getArgVariable( )

Parameters:

Code:

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

private any getArgVariableValue( )

Gets an arg variable value by using evaluate.

Parameters:

Code:

	<cffunction name="getArgVariableValue" access="private" returntype="any" output="false"
		hint="Gets an arg variable value by using evaluate.">
		
		<cfset var value = "" />
		<cfset var log = getLog() />
		
		<cfif IsDefined(getArgVariable())>
			<cfset value = Evaluate(getArgVariable()) />
		<cfelseif log.isDebugEnabled()>
			<cfset log.debug("No value found for arg variable named '#getArgVariable()#' for event-arg named '#getArgName()#'.") />
		</cfif>
		
		<cfreturn value />
	</cffunction> 

private boolean getOverwrite( )

Parameters:

Code:

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

public EventArgCommand init( string argName, [string argValue=""], [string argVariable=""], [boolean overwrite="true"] )

Used by the framework for initialization.

Parameters:

string argName

[string argValue=""]

[string argVariable=""]

[boolean overwrite="true"]

Code:

	<cffunction name="init" access="public" returntype="EventArgCommand" output="false"
		hint="Used by the framework for initialization.">
		<cfargument name="argName" type="string" required="true" />
		<cfargument name="argValue" type="string" required="false" default="" />
		<cfargument name="argVariable" type="string" required="false" default="" />
		<cfargument name="overwrite" type="boolean" required="false" default="true" />
		
		<cfset setArgName(arguments.argName) />
		<cfset setArgValue(arguments.argValue) />
		<cfset setArgVariable(arguments.argVariable) />
		<cfset setOverwrite(arguments.overwrite) />
		
		<cfreturn this />
	</cffunction> 

private boolean isArgValueDefined( )

Parameters:

Code:

	<cffunction name="isArgValueDefined" access="private" returntype="boolean" output="false">
		<cfreturn Len(variables.argValue) />
	</cffunction> 

private boolean isArgVariableDefined( )

Parameters:

Code:

	<cffunction name="isArgVariableDefined" access="private" returntype="boolean" output="false">
		<cfreturn Len(variables.argVariable) />
	</cffunction> 

private void setArgName( string argName )

Parameters:

string argName

Code:

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

private void setArgValue( string argValue )

Parameters:

string argValue

Code:

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

private void setArgVariable( string argVariable )

Parameters:

string argVariable

Code:

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

private void setOverwrite( string overwrite )

Parameters:

string overwrite

Code:

	<cffunction name="setOverwrite" access="private" returntype="void" output="false">
		<cfargument name="overwrite" type="string" required="true" />
		
		<cfset variables.overwrite = (arguments.overwrite IS NOT "false") />
	</cffunction>