org.andromda.cartridges.bpm4struts.metafacades

Interface StrutsJsp

All Superinterfaces:

ActionStateFacade, FrontEndActionState, FrontEndView, ModelElementFacade, StateFacade, StateVertexFacade, StrutsActionState

All Known Implementing Classes:

StrutsJspLogic, StrutsJspLogicImpl

public interface StrutsJsp
extends StrutsActionState, FrontEndView

A Struts JSP represents a page in the web application. A page possibly contains several forms and triggers (either buttons or hyperlinks) that call actions. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getCssFileName() The name of the file containing specific styles for this page only.
String	getDocumentationKey() A resource message key suited for the page's documentation.
String	getDocumentationValue() A resource message value suited for the page's documentation.
String	getFullPath() The full path to this JSP page.
List<StrutsAction>	getIncomingActions() Returns all actions that possibly result in returning this page.
String	getMessageKey() The default resource message key.
String	getMessageValue() A displayable version of this page's name.
List<StrutsForward>	getNonActionForwards() The collection of outgoing forwards that are not actions.
String	getOnlineHelpActionPath() The full path to this JSP's online help action.
String	getOnlineHelpKey() The key to lookup the online help documentation.
String	getOnlineHelpPagePath() The full path to this JSP's online help page.
String	getOnlineHelpValue() The online help documentation.
List<StrutsParameter>	getPageVariables() Returns all those variables that will be present as variables in the target page.
String	getTitleKey() A resource message key suited for the page's title.
String	getTitleValue() A default resource message value suited for the page's title.
boolean	isCalendarRequired() True if this JSP contains a date field which requires a calendar popup.
boolean	isDateFieldPresent() True if any of the actions have a parameter of type Date.
boolean	isStrutsJspMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isValidationRequired() True if at least one client/server parameter requires validation.

Methods inherited from interface org.andromda.cartridges.bpm4struts.metafacades.StrutsActionState

isStrutsActionStateMetaType

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

getActions, getAllActionParameters, getAllFormFields, getTables, getUseCase, getVariables, isFrontEndView, isFrontEndViewMetaType

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

getActionMethodName, getContainerActions, getControllerCalls, getExceptions, getForward, getServiceCalls, isContainedInFrontEndUseCase, isFrontEndActionStateMetaType, isServerSide

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

getEntry, isActionStateFacadeMetaType

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

getDeferrableEvents, isStateFacadeMetaType

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

getContainer, getIncomings, getOutgoings, getPartition, getStateMachine, isStateVertexFacadeMetaType

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

isStrutsJspMetaType

boolean isStrutsJspMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getCssFileName

String getCssFileName()

The name of the file containing specific styles for this page only.

Returns:

String

getDocumentationKey

String getDocumentationKey()

A resource message key suited for the page's documentation.

Returns:

String

getDocumentationValue

String getDocumentationValue()

A resource message value suited for the page's documentation.

Returns:

String

getFullPath

String getFullPath()

The full path to this JSP page. the returned String does not have a suffix such as '.jsp'.

Returns:

String

getIncomingActions

List<StrutsAction> getIncomingActions()

Returns all actions that possibly result in returning this page.

Returns:

List

getMessageKey

String getMessageKey()

The default resource message key.

Returns:

String

getMessageValue

String getMessageValue()

A displayable version of this page's name.

Returns:

String

getNonActionForwards

List<StrutsForward> getNonActionForwards()

The collection of outgoing forwards that are not actions.

Returns:

List

getOnlineHelpActionPath

String getOnlineHelpActionPath()

The full path to this JSP's online help action. The returned String does not have a suffix such as '.do'.

Returns:

String

getOnlineHelpKey

String getOnlineHelpKey()

The key to lookup the online help documentation. This documentation is gathered from the documentation entered by the user, as well as analyzing the model.

Returns:

String

getOnlineHelpPagePath

String getOnlineHelpPagePath()

The full path to this JSP's online help page. The returned String does not have a suffix such as '.jsp'.

Returns:

String

getOnlineHelpValue

String getOnlineHelpValue()

The online help documentation. This documentation is gathered from the documentation entered by the user, as well as analyzing the model. The format is HTML without any style.

Returns:

String

getPageVariables

List<StrutsParameter> getPageVariables()

Returns all those variables that will be present as variables in the target page. These are the trigger parameters on the incoming transitions.

Returns:

List

getTitleKey

String getTitleKey()

A resource message key suited for the page's title.

Returns:

String

getTitleValue

String getTitleValue()

A default resource message value suited for the page's title.

Returns:

String

isCalendarRequired

boolean isCalendarRequired()

True if this JSP contains a date field which requires a calendar popup.

Returns:

boolean

isDateFieldPresent

boolean isDateFieldPresent()

True if any of the actions have a parameter of type Date.

Returns:

boolean

isValidationRequired

boolean isValidationRequired()

True if at least one client/server parameter requires validation.

Returns:

boolean