| Package: MachII.framework |
| Inherits from: framework.BaseComponent |
| Base Plugin component. |
| Method Summary | |
|---|---|
| public Plugin |
init(AppManager appManager, [struct parameters])
Used by the framework for initialization. Do not override. |
| public void |
abortEvent([string message=""])
Call this function to abort processing of the current event. When called, an AbortEventException exception is thrown, caught, and handled by the framework. |
| public void |
handleException(EventContext eventContext, Exception exception)
Plugin point called when an exception occurs (before exception event is handled). Override to provide custom functionality. |
| public void |
postEvent(EventContext eventContext)
Plugin point called after each Event is processed. Override to provide custom functionality. |
| public void |
postProcess(EventContext eventContext)
Plugin point called after Event processing finishes. Override to provide custom functionality. |
| public void |
postView(EventContext eventContext)
Plugin point called after each View is processed. Override to provide custom functionality. |
| public void |
preEvent(EventContext eventContext)
Plugin point called before each Event is processed. Override to provide custom functionality. |
| public void |
preProcess(EventContext eventContext)
Plugin point called before Event processing begins. Override to provide custom functionality. |
| public void |
preView(EventContext eventContext)
Plugin point called before each View is processed. Override to provide custom functionality. |
| Methods inherited from framework.BaseComponent: setParameters , hasParameter , buildUrlToModule , isParameterDefined , buildUrl , announceEventInModule , setAppManager , getParameter , getProperty , getParameters , setProperty , getPropertyManager , bindValue , configure , getAppManager , setParameter , announceEvent |
|---|
| Method Detail |
|---|
| abortEvent |
|---|
public void abortEvent( [string message=""] )
Call this function to abort processing of the current event. When called, an AbortEventException exception is thrown, caught, and handled by the framework.
Parameters:
| [string message=""] |
Code:
<cffunction name="abortEvent" access="public" returntype="void" output="false" hint="Call this function to abort processing of the current event. When called, an AbortEventException exception is thrown, caught, and handled by the framework."> <cfargument name="message" type="string" required="false" default="" /> <cfthrow type="AbortEventException" message="#arguments.message#" /> </cffunction>
| handleException |
|---|
public void handleException( EventContext eventContext, Exception exception )
Plugin point called when an exception occurs (before exception event is handled). Override to provide custom functionality.
Parameters:
| EventContext eventContext |
| Exception exception |
Code:
<cffunction name="handleException" access="public" returntype="void" output="true" hint="Plugin point called when an exception occurs (before exception event is handled). Override to provide custom functionality."> <cfargument name="eventContext" type="MachII.framework.EventContext" required="true" hint="The EventContext under which the exception was thrown/caught." /> <cfargument name="exception" type="MachII.util.Exception" required="true" hint="The Exception that was thrown/caught by the framework." /> </cffunction>
| init |
|---|
public Plugin init( AppManager appManager, [struct parameters] )
Used by the framework for initialization. Do not override.
Parameters:
| AppManager appManager |
| [struct parameters] |
Code:
<cffunction name="init" access="public" returntype="Plugin" 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" /> <cfset super.init(arguments.appManager, arguments.parameters) /> <cfreturn this /> </cffunction>
| postEvent |
|---|
public void postEvent( EventContext eventContext )
Plugin point called after each Event is processed. Override to provide custom functionality.
Parameters:
| EventContext eventContext |
Code:
<cffunction name="postEvent" access="public" returntype="void" output="true" hint="Plugin point called after each Event is processed. Override to provide custom functionality."> <cfargument name="eventContext" type="MachII.framework.EventContext" required="true" hint="The EventContext the Event occurred in. Call arguments.eventContext.getCurrentEvent() to access the Event." /> </cffunction>
| postProcess |
|---|
public void postProcess( EventContext eventContext )
Plugin point called after Event processing finishes. Override to provide custom functionality.
Parameters:
| EventContext eventContext |
Code:
<cffunction name="postProcess" access="public" returntype="void" output="true" hint="Plugin point called after Event processing finishes. Override to provide custom functionality."> <cfargument name="eventContext" type="MachII.framework.EventContext" required="true" hint="The EventContext of the processing." /> </cffunction>
| postView |
|---|
public void postView( EventContext eventContext )
Plugin point called after each View is processed. Override to provide custom functionality.
Parameters:
| EventContext eventContext |
Code:
<cffunction name="postView" access="public" returntype="void" output="true" hint="Plugin point called after each View is processed. Override to provide custom functionality."> <cfargument name="eventContext" type="MachII.framework.EventContext" required="true" hint="The EventContext of the processing." /> </cffunction>
| preEvent |
|---|
public void preEvent( EventContext eventContext )
Plugin point called before each Event is processed. Override to provide custom functionality.
Parameters:
| EventContext eventContext |
Code:
<cffunction name="preEvent" access="public" returntype="void" output="true" hint="Plugin point called before each Event is processed. Override to provide custom functionality."> <cfargument name="eventContext" type="MachII.framework.EventContext" required="true" hint="The EventContext the Event occurred in. Call arguments.eventContext.getCurrentEvent() to access the Event." /> </cffunction>
| preProcess |
|---|
public void preProcess( EventContext eventContext )
Plugin point called before Event processing begins. Override to provide custom functionality.
Parameters:
| EventContext eventContext |
Code:
<cffunction name="preProcess" access="public" returntype="void" output="true" hint="Plugin point called before Event processing begins. Override to provide custom functionality."> <cfargument name="eventContext" type="MachII.framework.EventContext" required="true" hint="The EventContext of the processing." /> </cffunction>
| preView |
|---|
public void preView( EventContext eventContext )
Plugin point called before each View is processed. Override to provide custom functionality.
Parameters:
| EventContext eventContext |
Code:
<cffunction name="preView" access="public" returntype="void" output="true" hint="Plugin point called before each View is processed. Override to provide custom functionality."> <cfargument name="eventContext" type="MachII.framework.EventContext" required="true" hint="The EventContext of the processing." /> </cffunction>