| Package: MachII.framework |
| Handles processing of EventCommands for an Event. |
| Method Summary | |
|---|---|
| public EventHandler |
init(string access)
Used by the framework for initialization. Do not override. |
| public void |
addCommand(Command command)
Adds an Command. |
| public string | getAccess() |
| public void |
handleEvent(Event event, EventContext eventContext)
Handles an Event. |
| public void | setAccess(string access) |
| Method Detail |
|---|
| addCommand |
|---|
public void addCommand( Command command )
Adds an Command.
Parameters:
| Command command |
Code:
<cffunction name="addCommand" access="public" returntype="void" output="false" hint="Adds an Command."> <cfargument name="command" type="MachII.framework.Command" required="true" /> <cfset ArrayAppend(variables.commands, arguments.command) /> </cffunction>
| getAccess |
|---|
public string getAccess( )
Parameters:
Code:
<cffunction name="getAccess" access="public" returntype="string" output="false"> <cfreturn variables.access /> </cffunction>
| handleEvent |
|---|
public void handleEvent( Event event, EventContext eventContext )
Handles an Event.
Parameters:
| Event event |
| EventContext eventContext |
Code:
<cffunction name="handleEvent" access="public" returntype="void" output="true" hint="Handles an Event."> <cfargument name="event" type="MachII.framework.Event" required="true" /> <cfargument name="eventContext" type="MachII.framework.EventContext" required="true" /> <cfset var continue = true /> <cfset var command = "" /> <cfset var i = 0 /> <cfloop from="1" to="#ArrayLen(variables.commands)#" index="i"> <cfset command = variables.commands[i] /> <cfset continue = command.execute(arguments.event, arguments.eventContext) /> <cfif continue IS false> <cfbreak /> </cfif> </cfloop> </cffunction>
| init |
|---|
public EventHandler init( string access )
Used by the framework for initialization. Do not override.
Parameters:
| string access |
Code:
<cffunction name="init" access="public" returntype="EventHandler" output="false" hint="Used by the framework for initialization. Do not override."> <cfargument name="access" type="string" required="true" /> <cfset setAccess(arguments.access) /> <cfreturn this /> </cffunction>
| setAccess |
|---|
public void setAccess( string access )
Parameters:
| string access |
Code:
<cffunction name="setAccess" access="public" returntype="void" output="false"> <cfargument name="access" type="string" required="true" /> <cfset variables.access = arguments.access /> </cffunction>