org.andromda.metafacades.uml

Interface FrontEndUseCase

All Superinterfaces:

ClassifierFacade, GeneralizableElementFacade, ModelElementFacade, NamespaceFacade, UseCaseFacade

public interface FrontEndUseCase
extends UseCaseFacade

Represents a use case used in the "front end" of an application. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
List<FrontEndAction>	getActions() The actions for this use-case.
FrontEndActivityGraph	getActivityGraph() Returns the activity graph describing this use-case in more detail.
List<Role>	getAllRoles() All roles that directly or indirectly related to any "front-end" use cases.
List<FrontEndUseCase>	getAllUseCases() Returns all struts use-cases in this "front end" application.
FrontEndController	getController() Returns the controller for this use-case.
FrontEndView	getInitialView() The first view of this use case, this may actually return a view of another use case if the first is found by traveling through the final state.
List<FrontEndFinalState>	getReferencingFinalStates() The final states linking to this use case
List<Role>	getRoles() Returns all roles that are directly and indirectly associated to this use-case.
List<FrontEndView>	getViews() All views that are part of this use case.
List<FrontEndParameter>	getViewVariables() The variables for all views in this use-case.
boolean	isEntryUseCase() True if this use-case is the entry point to the front end.
boolean	isFrontEndUseCaseMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isSecured() Indicates if this use case is "secured".

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

isFrontEndUseCaseMetaType

boolean isFrontEndUseCaseMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getActions

List<FrontEndAction> getActions()

The actions for this use-case. This will include the initial action to start the use-case.

Returns:

List

getActivityGraph

FrontEndActivityGraph getActivityGraph()

Returns the activity graph describing this use-case in more detail.

Returns:

FrontEndActivityGraph

getAllRoles

List<Role> getAllRoles()

All roles that directly or indirectly related to any "front-end" use cases.

Returns:

List

getAllUseCases

List<FrontEndUseCase> getAllUseCases()

Returns all struts use-cases in this "front end" application.

Returns:

List

getController

FrontEndController getController()

Returns the controller for this use-case.

Returns:

FrontEndController

getInitialView

FrontEndView getInitialView()

The first view of this use case, this may actually return a view of another use case if the first is found by traveling through the final state.

Returns:

FrontEndView

getReferencingFinalStates

List<FrontEndFinalState> getReferencingFinalStates()

The final states linking to this use case

Returns:

List

getRoles

List<Role> getRoles()

Returns all roles that are directly and indirectly associated to this use-case.

Returns:

List

getViewVariables

List<FrontEndParameter> getViewVariables()

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

Returns:

List

getViews

List<FrontEndView> getViews()

All views that are part of this use case.

Returns:

List

isEntryUseCase

boolean isEntryUseCase()

True if this use-case is the entry point to the front end.

Returns:

boolean

isSecured

boolean isSecured()

Indicates if this use case is "secured". This is true when there is at least one role associated to it.

Returns:

boolean