EventHandlerBean

coldbox.system.web.context

Class EventHandlerBean

lucee.Component
    coldbox.system.web.context.EventHandlerBean

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- I model a ColdBox Event Handler Execution

Class Attributes:

synchronized : false

accessors : true

persistent : false

Property Summary
type	property	default	serializable	required
`struct`	actionMetadata Action metadata. access = public returntype = any		`true`	`false`
`any`	handler The handler to execute. access = public returntype = any		`true`	`false`
`struct`	handlerMetadata Handler metadata. access = public returntype = any		`true`	`false`
`any`	invocationPath Invocation path. access = public returntype = any		`true`	`false`
`boolean`	isPrivate Private execution. access = public returntype = any		`true`	`false`
`any`	method The method to execute. access = public returntype = any		`true`	`false`
`any`	missingAction Missing action method. access = public returntype = any		`true`	`false`
`any`	module The module assignment. access = public returntype = any		`true`	`false`
`boolean`	viewDispatch View dispatching. access = public returntype = any		`true`	`false`

Constructor Summary
init([any invocationPath='']) Constructor.

Method Summary
`any`	getActionMetadata([any key], [any defaultValue='']) Return the full action metadata structure or filter by key and default value if needed.
`any`	getFullEvent() Get the full execution string.
`string`	getHandler()
`any`	getHandlerMetadata([any key], [any defaultValue='']) Return the full handler metadata structure or filter by key and default value if needed.
`string`	getInvocationPath()
`string`	getIsPrivate()
`string`	getMethod()
`string`	getMissingAction()
`string`	getModule()
`any`	getRunnable() Get the runnable execution path.
`string`	getViewDispatch()
`boolean`	isMissingAction() Are we in missing action execution.
`boolean`	isModule() Is this a module execution.
`any`	setActionMetadata(any actionMetadata)
`any`	setHandler(any handler)
`any`	setHandlerMetadata(any handlerMetadata)
`any`	setInvocationPath(any invocationPath)
`any`	setIsPrivate(any isPrivate) PUBLIC RETURN BACK SETTERS ********************************************.
`any`	setMethod(any method)
`any`	setMissingAction(any missingAction)
`any`	setModule(any module)
`any`	setViewDispatch(any viewDispatch)

Methods inherited from class `lucee.Component`
None

Constructor Detail

init

public init([any invocationPath=''])

Constructor

Parameters:: invocationPath - The default invocation path

Property Detail

actionMetadata

property struct actionMetadata

Action metadata

Attributes:: access - public; required - false; returntype - any; serializable - true

handler

property any handler

The handler to execute

Attributes:: access - public; required - false; returntype - any; serializable - true

handlerMetadata

property struct handlerMetadata

Handler metadata

Attributes:: access - public; required - false; returntype - any; serializable - true

invocationPath

property any invocationPath

Invocation path

Attributes:: access - public; required - false; returntype - any; serializable - true

isPrivate

property boolean isPrivate

Private execution

Attributes:: access - public; required - false; returntype - any; serializable - true

method

property any method

The method to execute

Attributes:: access - public; required - false; returntype - any; serializable - true

missingAction

property any missingAction

Missing action method

Attributes:: access - public; required - false; returntype - any; serializable - true

module

property any module

The module assignment

Attributes:: access - public; required - false; returntype - any; serializable - true

viewDispatch

property boolean viewDispatch

View dispatching

Attributes:: access - public; required - false; returntype - any; serializable - true

Method Detail

getActionMetadata

public any getActionMetadata([any key], [any defaultValue=''])

Return the full action metadata structure or filter by key and default value if needed

Parameters:: key - The key to search for in the action metadata; defaultValue - Default value to return if not found

Returns:: any

getFullEvent

public any getFullEvent()

Get the full execution string

getHandler

public string getHandler()

getHandlerMetadata

public any getHandlerMetadata([any key], [any defaultValue=''])

Return the full handler metadata structure or filter by key and default value if needed

Parameters:: key - The key to search for in the handler metadata; defaultValue - Default value to return if not found

Returns:: any

getInvocationPath

public string getInvocationPath()

getIsPrivate

public string getIsPrivate()

getMethod

public string getMethod()

getMissingAction

public string getMissingAction()

getModule

public string getModule()

getRunnable

public any getRunnable()

Get the runnable execution path

getViewDispatch

public string getViewDispatch()

isMissingAction

public boolean isMissingAction()

Are we in missing action execution

isModule

public boolean isModule()

Is this a module execution

setActionMetadata

public any setActionMetadata(any actionMetadata)

Parameters:: actionMetadata

setHandler

public any setHandler(any handler)

Parameters:: handler

setHandlerMetadata

public any setHandlerMetadata(any handlerMetadata)

Parameters:: handlerMetadata

setInvocationPath

public any setInvocationPath(any invocationPath)

Parameters:: invocationPath

setIsPrivate

public any setIsPrivate(any isPrivate)

PUBLIC RETURN BACK SETTERS ********************************************

Parameters:: isPrivate

setMethod

public any setMethod(any method)

Parameters:: method

setMissingAction

public any setMissingAction(any missingAction)

Parameters:: missingAction

setModule

public any setModule(any module)

Parameters:: module

setViewDispatch

public any setViewDispatch(any viewDispatch)

Parameters:: viewDispatch