org.andromda.cartridges.bpm4struts.metafacades
Interface StrutsForward

All Superinterfaces:

org.andromda.metafacades.uml.FrontEndForward, org.andromda.metafacades.uml.ModelElementFacade, org.andromda.metafacades.uml.TransitionFacade

All Known Subinterfaces:

StrutsAction, StrutsExceptionHandler

All Known Implementing Classes:

StrutsActionLogic, StrutsActionLogicImpl, StrutsExceptionHandlerLogic, StrutsExceptionHandlerLogicImpl, StrutsForwardLogic, StrutsForwardLogicImpl

public interface StrutsForward
extends org.andromda.metafacades.uml.FrontEndForward

A Struts forward is any transition between states. Some of these forwards may end up as actual forwards in the Struts deployment descriptor.

Metafacade interface to be used by AndroMDA cartridges.

Method Summary

java.lang.String	getForwardName() The name for this forward.
java.lang.String	getForwardPath() Returns the path targetted by this forward.
java.lang.String	getGuardName() If this forward is guarded (such as with decision points) this method return the name of that guard.
StrutsActivityGraph	getStrutsActivityGraph() Returns the activity graph which holds this action if the graph is contained in a FrontEndUseCase.
java.util.Map	getSuccessMessages() A map of key=value pairs, one for each success message.
java.lang.String	getTargetNameKey() The resource bundle key of the name for the target element.
java.util.Map	getWarningMessages() A map of key=value pairs, one for each warning message.
boolean	isEnteringPage() True if this action directly targets a JSP page, false otherwise.
boolean	isExitingPage() Whether or not this forward (transition) is coming out of a page.
boolean	isStrutsForwardMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isSuccessMessagesPresent()
boolean	isWarningMessagesPresent()

Methods inherited from interface org.andromda.metafacades.uml.FrontEndForward

getActionMethodName, getActions, getDecisionTrigger, getForwardParameters, getFrontEndActivityGraph, getOperationCall, getUseCase, isContainedInFrontEndUseCase, isEnteringView, isExitingView, isFrontEndForwardMetaType

Methods inherited from interface org.andromda.metafacades.uml.TransitionFacade

getEffect, getGuard, getSource, getTarget, getTrigger, isEnteringActionState, isEnteringDecisionPoint, isEnteringFinalState, isExitingActionState, isExitingDecisionPoint, isExitingInitialState, isTransitionFacadeMetaType, isTriggerPresent

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

copyTaggedValues, findTaggedValue, findTaggedValues, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isModelElementFacadeMetaType, isTemplateParametersPresent, translateConstraint, translateConstraints, translateConstraints, validateInvariants

Method Detail

isStrutsForwardMetaType

boolean isStrutsForwardMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

always true

getForwardName

java.lang.String getForwardName()

The name for this forward. This name is always lowercase and words are separated using dots, not unlike the convention for Java package names.

getForwardPath

java.lang.String getForwardPath()

Returns the path targetted by this forward.

getGuardName

java.lang.String getGuardName()

If this forward is guarded (such as with decision points) this method return the name of that guard.

getStrutsActivityGraph

StrutsActivityGraph getStrutsActivityGraph()

Returns the activity graph which holds this action if the graph is contained in a FrontEndUseCase.

getSuccessMessages

java.util.Map getSuccessMessages()

A map of key=value pairs, one for each success message.

getTargetNameKey

java.lang.String getTargetNameKey()

The resource bundle key of the name for the target element. This method returns the key for the use-case or jsp page. If targetting anything else this method returns null.

getWarningMessages

java.util.Map getWarningMessages()

A map of key=value pairs, one for each warning message.

isEnteringPage

boolean isEnteringPage()

True if this action directly targets a JSP page, false otherwise.

isExitingPage

boolean isExitingPage()

Whether or not this forward (transition) is coming out of a page.

isSuccessMessagesPresent

boolean isSuccessMessagesPresent()

isWarningMessagesPresent

boolean isWarningMessagesPresent()