org.andromda.cartridges.bpm4struts.metafacades

Interface StrutsForward

All Superinterfaces:

FrontEndForward, ModelElementFacade, TransitionFacade

All Known Subinterfaces:

StrutsAction, StrutsExceptionHandler

All Known Implementing Classes:

StrutsActionLogic, StrutsActionLogicImpl, StrutsExceptionHandlerLogic, StrutsExceptionHandlerLogicImpl, StrutsForwardLogic, StrutsForwardLogicImpl

public interface StrutsForward
extends 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

Methods

Modifier and Type	Method and Description
String	getForwardName() The name for this forward.
String	getForwardPath() Returns the path targetted by this forward.
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.
Map	getSuccessMessages() A map of key=value pairs, one for each success message.
String	getTargetNameKey() The resource bundle key of the name for the target element.
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() TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.successMessagesPresent
boolean	isWarningMessagesPresent() TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.warningMessagesPresent

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, getBindedFullyQualifiedName, getConstraints, getConstraints, getDocumentation, getDocumentation, getDocumentation, getFullyQualifiedName, getFullyQualifiedName, getFullyQualifiedNamePath, getId, getKeywords, getLabel, getLanguageMappings, getModel, getName, getPackage, getPackageName, getPackageName, getPackagePath, getQualifiedName, getRootPackage, getSourceDependencies, getStateMachineContext, getStereotypeNames, getStereotypes, getTaggedValues, getTargetDependencies, getTemplateParameter, getTemplateParameters, getValidationName, getValidationOwner, getVisibility, hasExactStereotype, hasKeyword, hasStereotype, initialize, isBindingDependenciesPresent, isConstraintsPresent, isDocumentationPresent, isModelElementFacadeMetaType, isReservedWord, isTemplateParametersPresent, isValidIdentifierName, translateConstraint, translateConstraints, translateConstraints, validateInvariants

Method Detail

isStrutsForwardMetaType

boolean isStrutsForwardMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getForwardName

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.

Returns:

String

getForwardPath

String getForwardPath()

Returns the path targetted by this forward.

Returns:

String

getGuardName

String getGuardName()

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

Returns:

String

getStrutsActivityGraph

StrutsActivityGraph getStrutsActivityGraph()

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

Returns:

StrutsActivityGraph

getSuccessMessages

Map getSuccessMessages()

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

Returns:

Map

getTargetNameKey

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.

Returns:

String

getWarningMessages

Map getWarningMessages()

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

Returns:

Map

isEnteringPage

boolean isEnteringPage()

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

Returns:

boolean

isExitingPage

boolean isExitingPage()

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

Returns:

boolean

isSuccessMessagesPresent

boolean isSuccessMessagesPresent()

TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.successMessagesPresent

Returns:

boolean

isWarningMessagesPresent

boolean isWarningMessagesPresent()

TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsForward.warningMessagesPresent

Returns:

boolean