EventBeanCommand

Package: MachII.framework.commands
Inherits from: framework.Command
An Command for creating and populating a bean in the current event.

<!--- License: Copyright 2008 GreatBizTools, LLC Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. Copyright: GreatBizTools, LLC Author: Ben Edwards (ben@ben-edwards.com) $Id: EventBeanCommand.cfc 774 2008-05-11 04:00:35Z peterfarrell $ Created version: 1.0.6 Updated version: 1.5.0 Notes: --->

Method Summary
public EventBeanCommand init(string beanName, string beanType, string beanFields, boolean reinit, BeanUtil beanUtil)

Used by the framework for initialization.

public boolean execute(Event event, EventContext eventContext)

Executes the command.

private string getBeanFields()
private string getBeanName()
private string getBeanType()
private BeanUtil getBeanUtil()
private boolean getReinit()
public boolean isBeanFieldsDefined()
private void setBeanFields(string beanFields)
private void setBeanName(string beanName)
private void setBeanType(string beanType)
private void setBeanUtil(BeanUtil beanUtil)
private void setReinit(boolean reinit)
Methods inherited from framework.Command:   getLog , setParameter , getPropertyManager , setParameters , setLog , setExpressionEvaluator , getExpressionEvaluator , getParameter , setPropertyManager
Method Detail
execute

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 bean = "" />
		<cfset var log = getLog() />
		
		
		<cfif NOT getReinit() AND arguments.event.isArgDefined(getBeanName())>
			<cfif log.isDebugEnabled()>
				<cfset log.debug("Event-bean '#getBeanName()#' already in event. Repopulated with data.") />
			</cfif>
			
			<cfset bean = arguments.event.getArg(getBeanName()) />
			
			<cfif isBeanFieldsDefined()>
				<cfset getBeanUtil().setBeanFields(bean, getBeanFields(), arguments.event.getArgs()) />
			<cfelse>
				<cfset getBeanUtil().setBeanAutoFields(bean, arguments.event.getArgs()) />
			</cfif>
		<cfelse>
			<cfif log.isDebugEnabled()>
				<cfset log.debug("Event-bean '#getBeanName()#' created and populated with data.") />
			</cfif>

			<cfif isBeanFieldsDefined()>
				<cfset bean = getBeanUtil().createBean(getBeanType()) />
				<cfset getBeanUtil().setBeanFields(bean, getBeanFields(), arguments.event.getArgs()) />
			<cfelse>
				<cfset bean = getBeanUtil().createBean(getBeanType(), arguments.event.getArgs()) />
			</cfif>			

			<cfset arguments.event.setArg(getBeanName(), bean, getBeanType()) />
		</cfif>
		
		<cfreturn true />
	</cffunction>

getBeanFields

private string getBeanFields( )

Parameters:

Code: 

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

getBeanName

private string getBeanName( )

Parameters:

Code: 

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

getBeanType

private string getBeanType( )

Parameters:

Code: 

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

getBeanUtil

private BeanUtil getBeanUtil( )

Parameters:

Code: 

	<cffunction name="getBeanUtil" access="private" returntype="MachII.util.BeanUtil" output="false">
		<cfreturn variables.beanUtil />
	</cffunction>

getReinit

private boolean getReinit( )

Parameters:

Code: 

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

init

public EventBeanCommand init( string beanName, string beanType, string beanFields, boolean reinit, BeanUtil beanUtil )

Used by the framework for initialization.

Parameters:
string beanName
string beanType
string beanFields
boolean reinit
BeanUtil beanUtil

Code: 

	<cffunction name="init" access="public" returntype="EventBeanCommand" output="false"
		hint="Used by the framework for initialization.">
		<cfargument name="beanName" type="string" required="true" />
		<cfargument name="beanType" type="string" required="true" />
		<cfargument name="beanFields" type="string" required="true" />
		<cfargument name="reinit" type="boolean" required="true" />
		<cfargument name="beanUtil" type="MachII.util.BeanUtil" required="true" />
		
		<cfset setBeanName(arguments.beanName) />
		<cfset setBeanType(arguments.beanType) />
		<cfset setBeanFields(arguments.beanFields) />
		<cfset setReinit(arguments.reinit) />
		<cfset setBeanUtil(arguments.beanUtil) />
		
		<cfreturn this />
	</cffunction>

isBeanFieldsDefined

public boolean isBeanFieldsDefined( )

Parameters:

Code: 

	<cffunction name="isBeanFieldsDefined" access="public" returntype="boolean" output="false">
		<cfreturn Len(variables.beanFields) />
	</cffunction>

setBeanFields

private void setBeanFields( string beanFields )

Parameters:
string beanFields

Code: 

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

setBeanName

private void setBeanName( string beanName )

Parameters:
string beanName

Code: 

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

setBeanType

private void setBeanType( string beanType )

Parameters:
string beanType

Code: 

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

setBeanUtil

private void setBeanUtil( BeanUtil beanUtil )

Parameters:
BeanUtil beanUtil

Code: 

	<cffunction name="setBeanUtil" access="private" returntype="void" output="false">
		<cfargument name="beanUtil" type="MachII.util.BeanUtil" required="true" />
		<cfset variables.beanUtil = arguments.beanUtil />
	</cffunction>

setReinit

private void setReinit( boolean reinit )

Parameters:
boolean reinit

Code: 

	<cffunction name="setReinit" access="private" returntype="void" output="false">
		<cfargument name="reinit" type="boolean" required="true" />
		<cfset variables.reinit = arguments.reinit />
	</cffunction>