org.andromda.cartridges.bpm4struts.metafacades

Interface StrutsUseCase

All Superinterfaces:

ClassifierFacade, FrontEndUseCase, GeneralizableElementFacade, ModelElementFacade, NamespaceFacade, UseCaseFacade

All Known Implementing Classes:

StrutsUseCaseLogic, StrutsUseCaseLogicImpl

public interface StrutsUseCase
extends FrontEndUseCase

A Struts use-case represents a set of related client/server requests and communication. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionPath() This use-case's action path.
String	getActionPathRoot() The root of the action path.
String	getActionRoles() Returns the action roles corresponding to this use-case's action, as found in the struts deployment descriptor.
Map	getAllMessages() A map with keys sorted alphabetically, normalized across all different use-cases and pages etc..
List<StrutsJsp>	getAllPages() This method returns all pages in the application.
TreeNode	getApplicationHierarchyRoot() The root node of the application usecase hierarchy.
String	getCssFileName() The name of the file containing specific styles for this use-case only.
List<StrutsParameter>	getFormFields() Returns the form fields used in this use-case, in fact these are all the parameters used in client/server communication for this use-case.
String	getFormKey() The key under which to store the forms contained in this use-case.
TreeNode	getHierarchyRoot() The root of the hierarchy of application usecases where this usecase is at the top.
String	getOnlineHelpActionPath() The full path to this use-case's online help action.
String	getOnlineHelpKey() The key to lookup the online help documentation.
String	getOnlineHelpPagePath() The full path to this use-case's online help page.
String	getOnlineHelpValue() The online help documentation.
List<StrutsJsp>	getPages() This method returns all pages in the use-case.
List<StrutsParameter>	getPageVariables() The variables for all pages in this use-case.
String	getTitleKey() The title message key for this use-case.
String	getTitleValue() The title message value for this use-case.
boolean	isApplicationUseCase() True if this use-case is where the application starts.
boolean	isApplicationValidationRequired() True if at least one client/server parameter found in the collection of existing use-cases requires validation.
boolean	isCyclic() TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsUseCase.cyclic
boolean	isStrutsUseCaseMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isValidationRequired() True if some client/server parameters require validation for this use-case.

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

getActions, getActivityGraph, getAllRoles, getAllUseCases, getController, getInitialView, getReferencingFinalStates, getRoles, getViews, getViewVariables, isEntryUseCase, isFrontEndUseCaseMetaType, isSecured

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

getExtends, getExtensionPoints, getFirstActivityGraph, getIncludes, isUseCaseFacadeMetaType

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

getOwnedElements, isNamespaceFacadeMetaType

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

findAttribute, getAbstractions, getAllAssociatedClasses, getAllProperties, getAllRequiredConstructorParameters, getArray, getArrayName, getAssociatedClasses, getAssociationEnds, getAttributes, getAttributes, getFullyQualifiedArrayName, getImplementationOperations, getImplementedInterfaceList, getInstanceAttributes, getInstanceOperations, getInterfaceAbstractions, getJavaNewString, getJavaNullString, getNavigableConnectingEnds, getNavigableConnectingEnds, getNonArray, getOperationCallFromAttributes, getOperations, getProperties, getProperties, getRequiredConstructorParameters, getSerialVersionUID, getStaticAttributes, getStaticOperations, getSuperClass, getWrapperName, isAbstract, isArrayType, isAssociationClass, isBlobType, isBooleanType, isCharacterType, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isDoubleType, isEmbeddedValue, isEnumeration, isFileType, isFloatType, isIntegerType, isInterface, isLeaf, isListType, isLongType, isMapType, isPrimitive, isSetType, isStringType, isTimeType, isWrappedPrimitive

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

findTaggedValue, getAllGeneralizations, getAllSpecializations, getGeneralization, getGeneralizationLinks, getGeneralizationList, getGeneralizationRoot, getGeneralizations, getSpecializations, isGeneralizableElementFacadeMetaType

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

isStrutsUseCaseMetaType

boolean isStrutsUseCaseMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getActionPath

String getActionPath()

This use-case's action path.

Returns:

String

getActionPathRoot

String getActionPathRoot()

The root of the action path.

Returns:

String

getActionRoles

String getActionRoles()

Returns the action roles corresponding to this use-case's action, as found in the struts deployment descriptor. The action roles specifiy the roles in which the user must be in order to be authorized to call the action. One of the roles must be satisfied.

Returns:

String

getAllMessages

Map getAllMessages()

A map with keys sorted alphabetically, normalized across all different use-cases and pages etc..

Returns:

Map

getAllPages

List<StrutsJsp> getAllPages()

This method returns all pages in the application. A page is an action state with the FrontEndView stereotype.

Returns:

List

getApplicationHierarchyRoot

TreeNode getApplicationHierarchyRoot()

The root node of the application usecase hierarchy. Only makes sense when this usecase is an application usecase. Each usecase is only listed once in it's subtree, meaning when cycles ar edetected in the applicaion usecase graph the usecase will not be added when it already exists as an ancestor.

Returns:

TreeNode

getCssFileName

String getCssFileName()

The name of the file containing specific styles for this use-case only.

Returns:

String

getFormFields

List<StrutsParameter> getFormFields()

Returns the form fields used in this use-case, in fact these are all the parameters used in client/server communication for this use-case.

Returns:

List

getFormKey

String getFormKey()

The key under which to store the forms contained in this use-case.

Returns:

String

getHierarchyRoot

TreeNode getHierarchyRoot()

The root of the hierarchy of application usecases where this usecase is at the top. It is possible not all usecases are included in the descendants, they can be found in the collection of ancestor nodes.

Returns:

TreeNode

getOnlineHelpActionPath

String getOnlineHelpActionPath()

The full path to this use-case'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 use-case'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()

The variables for all pages in this use-case. A parameter qualifies to be a variable when it explicitly and directly receives it via an action.

Returns:

List

getPages

List<StrutsJsp> getPages()

This method returns all pages in the use-case. A page is an action state with the FrontEndView stereotype.

Returns:

List

getTitleKey

String getTitleKey()

The title message key for this use-case.

Returns:

String

getTitleValue

String getTitleValue()

The title message value for this use-case.

Returns:

String

isApplicationUseCase

boolean isApplicationUseCase()

True if this use-case is where the application starts.

Returns:

boolean

isApplicationValidationRequired

boolean isApplicationValidationRequired()

True if at least one client/server parameter found in the collection of existing use-cases requires validation.

Returns:

boolean

isCyclic

boolean isCyclic()

TODO: Model Documentation for org.andromda.cartridges.bpm4struts.metafacades.StrutsUseCase.cyclic

Returns:

boolean

isValidationRequired

boolean isValidationRequired()

True if some client/server parameters require validation for this use-case.

Returns:

boolean