org.dmd.mvw.tools.mvwgenerator.generated.dmw

Class ControllerDMW

java.lang.Object

org.dmd.dmc.DmcContainer

org.dmd.dmw.DmwWrapper

org.dmd.dmw.DmwNamedObjectWrapper

org.dmd.mvw.tools.mvwgenerator.generated.dmw.MvwDefinitionDMW

org.dmd.mvw.tools.mvwgenerator.extended.MvwDefinition

org.dmd.mvw.tools.mvwgenerator.generated.dmw.ComponentDMW

org.dmd.mvw.tools.mvwgenerator.extended.Component

org.dmd.mvw.tools.mvwgenerator.generated.dmw.ControllerDMW

All Implemented Interfaces:

org.dmd.dmc.DmcContainerIF, org.dmd.dmc.DmcNamedObjectIF, CodeGenComponentIF

Direct Known Subclasses:

Controller

public abstract class ControllerDMW
extends Component
implements org.dmd.dmc.DmcNamedObjectIF

The Controller represents a behavioural component that lives throughout\n the entire lifecycle of an WebApplication or WebSite. Generally, it manages the Presenters\n and Views that are displayed, but may also provide behind the scenes management of things\n like communications, security, menu structure etc. Controllers do not implement Presenter\n interfaces i.e. they do not interact directly with Views; that is the role of Presenters.\n

\n Because of their implied lifetime, Controllers are made part of the overall RunContext for\n an application and are constructed during initialization of the application. There is no\n need to instantiate Controllers separately. The RunContextItem created for a controller\n has the same name as the Controller itself with RCI appended. You may specify an itemOrder\n for the Controller to control when it is instantiated in the RunContext; use this option\n only if you know what you're doing! The default itemOrder is 50, most base related functionality\n starts in itemOrder 20 or lower.\n

\n Controllers should not communicate with other Controllers directly; this type of communication\n should be performed using events. So, although it is possible to get the handle to another\n Controller via the RunContext, it is discouraged.\n

Generated from the mvw schema at version 0.1

This code was auto-generated by the dmggenerator utility and shouldn't be alterred manually! Generated from: org.dmd.dmg.generators.BaseDMWGenerator.dumpWrapper(BaseDMWGenerator.java:488)

Field Summary

Fields inherited from class org.dmd.mvw.tools.mvwgenerator.extended.Component

abstractMethods, actionInstantiations, actionVariables, imports, initialized, usesRunContext

Fields inherited from class org.dmd.dmc.DmcContainer

core

Constructor Summary

Constructors

Modifier	Constructor and Description
	ControllerDMW()
	ControllerDMW(ControllerDMO obj)
protected	ControllerDMW(ControllerDMO obj, org.dmd.dms.ClassDefinition cd)
	ControllerDMW(org.dmd.dms.generated.types.DmcTypeModifierMV mods)

Method Summary

Modifier and Type	Method and Description
org.dmd.dmc.DmcAttribute<?>	addImplementsAction(ActionBinding value) Adds another implementsAction value.
org.dmd.dmc.DmcAttribute<?>	addInstantiatesPresenter(Presenter value) Adds another instantiatesPresenter value.
Controller	cloneIt()
void	delImplementsAction(ActionBinding value) Deletes a implementsAction value.
void	delInstantiatesPresenter(Presenter value) Deletes a instantiatesPresenter value.
boolean	equals(Object obj)
org.dmd.dmc.types.CamelCaseName	getControllerName()
ControllerDMO	getDMO()
ArrayList<ActionBinding>	getImplementsActionCopy()
boolean	getImplementsActionHasValue()
boolean	getImplementsActionIsEmpty()
ActionBindingIterableDMW	getImplementsActionIterable()
int	getImplementsActionSize()
ArrayList<Presenter>	getInstantiatesPresenterCopy()
boolean	getInstantiatesPresenterHasValue()
boolean	getInstantiatesPresenterIsEmpty()
PresenterIterableDMW	getInstantiatesPresenterIterable()
int	getInstantiatesPresenterSize()
Integer	getItemOrder()
Controller	getModificationRecorder()
org.dmd.dmc.types.CamelCaseName	getObjectName()
org.dmd.dmc.DmcAttribute<?>	getObjectNameAttribute()
int	hashCode()
Boolean	isAddedToRunContext()
Boolean	isCentralAsyncErrorHandler()
Boolean	isCentralDMPErrorHandler()
Boolean	isCentralRPCErrorHandler()
void	remAddedToRunContext() Removes the addedToRunContext attribute value.
void	remCentralAsyncErrorHandler() Removes the centralAsyncErrorHandler attribute value.
void	remCentralDMPErrorHandler() Removes the centralDMPErrorHandler attribute value.
void	remCentralRPCErrorHandler() Removes the centralRPCErrorHandler attribute value.
void	remControllerName() Removes the controllerName attribute value.
void	remImplementsAction() Removes the implementsAction attribute value.
void	remInstantiatesPresenter() Removes the instantiatesPresenter attribute value.
void	remItemOrder() Removes the itemOrder attribute value.
void	setAddedToRunContext(Boolean value) Sets addedToRunContext to the specified value.
void	setAddedToRunContext(Object value) Sets addedToRunContext to the specified value.
void	setCentralAsyncErrorHandler(Boolean value) Sets centralAsyncErrorHandler to the specified value.
void	setCentralAsyncErrorHandler(Object value) Sets centralAsyncErrorHandler to the specified value.
void	setCentralDMPErrorHandler(Boolean value) Sets centralDMPErrorHandler to the specified value.
void	setCentralDMPErrorHandler(Object value) Sets centralDMPErrorHandler to the specified value.
void	setCentralRPCErrorHandler(Boolean value) Sets centralRPCErrorHandler to the specified value.
void	setCentralRPCErrorHandler(Object value) Sets centralRPCErrorHandler to the specified value.
void	setControllerName(org.dmd.dmc.types.CamelCaseName value) Sets controllerName to the specified value.
void	setControllerName(Object value) Sets controllerName to the specified value.
void	setItemOrder(Integer value) Sets itemOrder to the specified value.
void	setItemOrder(Object value) Sets itemOrder to the specified value.

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.extended.Component

genSubPackage, getAbstractMethods, getActionInstantiations, getActionVariables, getAttributeSchemaLoaders, getBaseClassName, getCommsConstants, getCommsMethods, getEventRegistration, getFireMethods, getImports, handlesObjectEvents, hasCommsMethods, initCodeGenInfo, resetCodeGenInfo, usesCentralDmpErrorHandling, usesCentralRpcErrorHandling, usesRunContext

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.generated.dmw.ComponentDMW

addFiresEvent, addHandlesEvent, addInstantiatesView, addSendsRequest, addSendsRequest, addUseSchema, addUsesRunContextItem, delFiresEvent, delHandlesEvent, delInstantiatesView, delSendsRequest, delSendsRequest, delUseSchema, delUsesRunContextItem, getComponentName, getFiresEvent, getFiresEventCopy, getFiresEventFirstKey, getFiresEventHasValue, getFiresEventIsEmpty, getFiresEventIterable, getFiresEventSize, getHandlesEvent, getHandlesEventCopy, getHandlesEventFirstKey, getHandlesEventHasValue, getHandlesEventIsEmpty, getHandlesEventIterable, getHandlesEventSize, getInstantiatesViewCopy, getInstantiatesViewHasValue, getInstantiatesViewIsEmpty, getInstantiatesViewIterable, getInstantiatesViewSize, getSendsRequestCopy, getSendsRequestHasValue, getSendsRequestIsEmpty, getSendsRequestIterable, getSendsRequestSize, getSubpackage, getUseBaseClass, getUseSchemaCopy, getUseSchemaHasValue, getUseSchemaIsEmpty, getUseSchemaIterable, getUseSchemaSize, getUsesRunContextItemCopy, getUsesRunContextItemHasValue, getUsesRunContextItemIsEmpty, getUsesRunContextItemIterable, getUsesRunContextItemSize, remComponentName, remFiresEvent, remHandlesEvent, remInstantiatesView, remSendsRequest, remSubpackage, remUseBaseClass, remUseSchema, remUsesRunContextItem, sendsRequestContains, setComponentName, setComponentName, setSubpackage, setSubpackage, setUseBaseClass, setUseBaseClass

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.extended.MvwDefinition

resolveReferences

Methods inherited from class org.dmd.mvw.tools.mvwgenerator.generated.dmw.MvwDefinitionDMW

addDescription, addDescription, delDescription, delDescription, descriptionContains, getCamelCaseName, getDefinedInModule, getDescriptionCopy, getDescriptionHasValue, getDescriptionIsEmpty, getDescriptionIterable, getDescriptionSize, getFile, getLineNumber, remCamelCaseName, remDefinedInModule, remDescription, remFile, remLineNumber, setCamelCaseName, setCamelCaseName, setDefinedInModule, setDefinedInModule, setFile, setFile, setLineNumber, setLineNumber

Methods inherited from class org.dmd.dmw.DmwWrapper

addAux, applyModifier, getBackRefs, getConstructionClass, getConstructionClassInfo, getConstructionClassName, getDmcObject, getObjectClass, getReferringObjects, getReferringObjectsViaAttribute, hasAux, isReferenced, referenceCount, removeAux, resolveReferences, resolveReferences, serializeIt, setDmcObject, toOIF, toOIF, toPersistentOIF, toString, youAreDeleted

Methods inherited from class org.dmd.dmc.DmcContainer

getDeleted, getModifier, setDeleted, setModifier

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ControllerDMW

public ControllerDMW()

ControllerDMW

public ControllerDMW(org.dmd.dms.generated.types.DmcTypeModifierMV mods)

ControllerDMW

public ControllerDMW(ControllerDMO obj)

ControllerDMW

protected ControllerDMW(ControllerDMO obj,
                        org.dmd.dms.ClassDefinition cd)

Method Detail

getModificationRecorder

public Controller getModificationRecorder()

Overrides:

getModificationRecorder in class Component

cloneIt

public Controller cloneIt()

getDMO

public ControllerDMO getDMO()

Overrides:

getDMO in class ComponentDMW

getObjectName

public org.dmd.dmc.types.CamelCaseName getObjectName()

Specified by:

getObjectName in interface org.dmd.dmc.DmcNamedObjectIF

Overrides:

getObjectName in class ComponentDMW

hashCode

public int hashCode()

Overrides:

hashCode in class ComponentDMW

getObjectNameAttribute

public org.dmd.dmc.DmcAttribute<?> getObjectNameAttribute()

Specified by:

getObjectNameAttribute in interface org.dmd.dmc.DmcNamedObjectIF

Overrides:

getObjectNameAttribute in class ComponentDMW

equals

public boolean equals(Object obj)

Specified by:

equals in interface org.dmd.dmc.DmcNamedObjectIF

Overrides:

equals in class ComponentDMW

isAddedToRunContext

public Boolean isAddedToRunContext()

setAddedToRunContext

public void setAddedToRunContext(Object value)
                          throws org.dmd.dmc.DmcValueException

Sets addedToRunContext to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

org.dmd.dmc.DmcValueException

setAddedToRunContext

public void setAddedToRunContext(Boolean value)

Sets addedToRunContext to the specified value.

Parameters:

value - Boolean

remAddedToRunContext

public void remAddedToRunContext()

Removes the addedToRunContext attribute value.

isCentralAsyncErrorHandler

public Boolean isCentralAsyncErrorHandler()

setCentralAsyncErrorHandler

public void setCentralAsyncErrorHandler(Object value)
                                 throws org.dmd.dmc.DmcValueException

Sets centralAsyncErrorHandler to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

org.dmd.dmc.DmcValueException

setCentralAsyncErrorHandler

public void setCentralAsyncErrorHandler(Boolean value)

Sets centralAsyncErrorHandler to the specified value.

Parameters:

value - Boolean

remCentralAsyncErrorHandler

public void remCentralAsyncErrorHandler()

Removes the centralAsyncErrorHandler attribute value.

isCentralDMPErrorHandler

public Boolean isCentralDMPErrorHandler()

setCentralDMPErrorHandler

public void setCentralDMPErrorHandler(Object value)
                               throws org.dmd.dmc.DmcValueException

Sets centralDMPErrorHandler to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

org.dmd.dmc.DmcValueException

setCentralDMPErrorHandler

public void setCentralDMPErrorHandler(Boolean value)

Sets centralDMPErrorHandler to the specified value.

Parameters:

value - Boolean

remCentralDMPErrorHandler

public void remCentralDMPErrorHandler()

Removes the centralDMPErrorHandler attribute value.

isCentralRPCErrorHandler

public Boolean isCentralRPCErrorHandler()

setCentralRPCErrorHandler

public void setCentralRPCErrorHandler(Object value)
                               throws org.dmd.dmc.DmcValueException

Sets centralRPCErrorHandler to the specified value.

Parameters:

value - A value compatible with DmcTypeBoolean

Throws:

org.dmd.dmc.DmcValueException

setCentralRPCErrorHandler

public void setCentralRPCErrorHandler(Boolean value)

Sets centralRPCErrorHandler to the specified value.

Parameters:

value - Boolean

remCentralRPCErrorHandler

public void remCentralRPCErrorHandler()

Removes the centralRPCErrorHandler attribute value.

getControllerName

public org.dmd.dmc.types.CamelCaseName getControllerName()

setControllerName

public void setControllerName(Object value)
                       throws org.dmd.dmc.DmcValueException

Sets controllerName to the specified value.

Parameters:

value - A value compatible with DmcTypeCamelCaseName

Throws:

org.dmd.dmc.DmcValueException

setControllerName

public void setControllerName(org.dmd.dmc.types.CamelCaseName value)

Sets controllerName to the specified value.

Parameters:

value - CamelCaseName

remControllerName

public void remControllerName()

Removes the controllerName attribute value.

getImplementsActionSize

public int getImplementsActionSize()

Returns:

The number of ActionBinding items.

getImplementsActionIsEmpty

public boolean getImplementsActionIsEmpty()

Returns:

true if there are no ActionBindingDMO items.

getImplementsActionHasValue

public boolean getImplementsActionHasValue()

Returns:

true if there are any ActionBindingDMO items.

getImplementsActionIterable

public ActionBindingIterableDMW getImplementsActionIterable()

Returns:

An Iterator of ActionBindingDMO objects.

addImplementsAction

public org.dmd.dmc.DmcAttribute<?> addImplementsAction(ActionBinding value)

Adds another implementsAction value.

Parameters:

value - A value compatible with ActionBinding

delImplementsAction

public void delImplementsAction(ActionBinding value)

Deletes a implementsAction value.

Parameters:

value - The ActionBinding to be deleted from set of attribute values.

getImplementsActionCopy

public ArrayList<ActionBinding> getImplementsActionCopy()

Returns:

A COPY of the collection of ActionBinding objects.

remImplementsAction

public void remImplementsAction()

Removes the implementsAction attribute value.

getInstantiatesPresenterSize

public int getInstantiatesPresenterSize()

Returns:

The number of Presenter items.

getInstantiatesPresenterIsEmpty

public boolean getInstantiatesPresenterIsEmpty()

Returns:

true if there are no PresenterDMO items.

getInstantiatesPresenterHasValue

public boolean getInstantiatesPresenterHasValue()

Returns:

true if there are any PresenterDMO items.

getInstantiatesPresenterIterable

public PresenterIterableDMW getInstantiatesPresenterIterable()

Returns:

An Iterator of PresenterDMO objects.

addInstantiatesPresenter

public org.dmd.dmc.DmcAttribute<?> addInstantiatesPresenter(Presenter value)

Adds another instantiatesPresenter value.

Parameters:

value - A value compatible with Presenter

delInstantiatesPresenter

public void delInstantiatesPresenter(Presenter value)

Deletes a instantiatesPresenter value.

Parameters:

value - The Presenter to be deleted from set of attribute values.

getInstantiatesPresenterCopy

public ArrayList<Presenter> getInstantiatesPresenterCopy()

Returns:

A COPY of the collection of Presenter objects.

remInstantiatesPresenter

public void remInstantiatesPresenter()

Removes the instantiatesPresenter attribute value.

getItemOrder

public Integer getItemOrder()

setItemOrder

public void setItemOrder(Object value)
                  throws org.dmd.dmc.DmcValueException

Sets itemOrder to the specified value.

Parameters:

value - A value compatible with DmcTypeInteger

Throws:

org.dmd.dmc.DmcValueException

setItemOrder

public void setItemOrder(Integer value)

Sets itemOrder to the specified value.

Parameters:

value - Integer

remItemOrder

public void remItemOrder()

Removes the itemOrder attribute value.