org.andromda.cartridges.jsf.metafacades
Interface JSFUseCase

All Superinterfaces:

org.andromda.metafacades.uml.ClassifierFacade, org.andromda.metafacades.uml.FrontEndUseCase, org.andromda.metafacades.uml.GeneralizableElementFacade, org.andromda.metafacades.uml.ModelElementFacade, org.andromda.metafacades.uml.NamespaceFacade, org.andromda.metafacades.uml.UseCaseFacade

All Known Implementing Classes:

JSFUseCaseLogic, JSFUseCaseLogicImpl

public interface JSFUseCase
extends org.andromda.metafacades.uml.FrontEndUseCase

Represents a JSF use case.

Metafacade interface to be used by AndroMDA cartridges.

Method Summary

java.lang.String	getActionClassName() The name of the action class that forwards to this use case.
java.util.List	getActionForwards() All forwards in this use case that are represented as actions.
java.util.List	getAllForwards() Constains all forwards includes regular FrontEndForwards and all actiion forwards.
java.util.Map	getAllMessages() A map with keys sorted alphabetically, normalized across all different use-cases, views, etc.
java.lang.String	getControllerAction() The name of the action on the controller that executions this use case.
java.lang.String	getFormKey() The key under which to store the action form passed along in this in this use-case.
java.lang.String	getForwardName() The name that will cause a forward to use case.
java.util.List	getForwards() All forwards contained in this use case.
java.lang.String	getForwardsClassName() The name of the class that stores all the forwards paths.
java.lang.String	getFullyQualifiedActionClassName() The fully qualified name of the action class that forwards to this use case.
java.lang.String	getFullyQualifiedActionClassPath() The fully qualified path to the action class that forwards to this use case.
java.lang.String	getInitialTargetPath() The path of the initial target going into this use case.
java.util.Collection	getNavigationRules() Retrieves all navigation rules for the faces-config.xml
java.lang.String	getPath() The path to which this use case points.
java.lang.String	getPathRoot() The root path for this use case (this is the path the directory containing the use case's resources).
java.util.List	getRegistrationUseCases() All use cases that are labled as registration use cases.
java.lang.String	getTitleKey() The title message key for this use-case.
java.lang.String	getTitleValue() The title message value for this use-case.
boolean	isApplicationValidationRequired() Indicates that at least one client/server parameter found in the collection of existing use-cases requires validation.
boolean	isInitialTargetView() Indicates whether or not the initial target of this use case is a view or not.
boolean	isJSFUseCaseMetaType() Indicates the metafacade type (used for metafacade mappings).
boolean	isRegistrationUseCase() Indicates whether or not this is a front-end registration use case.
boolean	isValidationRequired() Indicates whether or not at least one parameter in this use-case require validation.
boolean	isViewHasNameOfUseCase() Indicates whether or not at least one view in the use case has the same name as 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, getJavaNullString, getNavigableConnectingEnds, getNavigableConnectingEnds, getNonArray, getOperationCallFromAttributes, getOperations, getProperties, getProperties, getRequiredConstructorParameters, getSerialVersionUID, getStaticAttributes, getStaticOperations, getSuperClass, getWrapperName, isAbstract, isArrayType, isAssociationClass, isBlobType, isBooleanType, isClassifierFacadeMetaType, isClobType, isCollectionType, isDataType, isDateType, isEmbeddedValue, isEnumeration, isFileType, isInterface, isLeaf, isListType, isMapType, isPrimitive, isSetType, isStringType, isTimeType

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, 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

isJSFUseCaseMetaType

boolean isJSFUseCaseMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

always true

getActionClassName

java.lang.String getActionClassName()

The name of the action class that forwards to this use case.

getActionForwards

java.util.List getActionForwards()

All forwards in this use case that are represented as actions.

getAllForwards

java.util.List getAllForwards()

Constains all forwards includes regular FrontEndForwards and all actiion forwards.

getAllMessages

java.util.Map getAllMessages()

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

getControllerAction

java.lang.String getControllerAction()

The name of the action on the controller that executions this use case.

getFormKey

java.lang.String getFormKey()

The key under which to store the action form passed along in this in this use-case.

getForwardName

java.lang.String getForwardName()

The name that will cause a forward to use case.

getForwards

java.util.List getForwards()

All forwards contained in this use case.

getForwardsClassName

java.lang.String getForwardsClassName()

The name of the class that stores all the forwards paths.

getFullyQualifiedActionClassName

java.lang.String getFullyQualifiedActionClassName()

The fully qualified name of the action class that forwards to this use case.

getFullyQualifiedActionClassPath

java.lang.String getFullyQualifiedActionClassPath()

The fully qualified path to the action class that forwards to this use case.

getInitialTargetPath

java.lang.String getInitialTargetPath()

The path of the initial target going into this use case.

getNavigationRules

java.util.Collection getNavigationRules()

Retrieves all navigation rules for the faces-config.xml

getPath

java.lang.String getPath()

The path to which this use case points.

getPathRoot

java.lang.String getPathRoot()

The root path for this use case (this is the path the directory containing the use case's resources).

getRegistrationUseCases

java.util.List getRegistrationUseCases()

All use cases that are labled as registration use cases.

getTitleKey

java.lang.String getTitleKey()

The title message key for this use-case.

getTitleValue

java.lang.String getTitleValue()

The title message value for this use-case.

isApplicationValidationRequired

boolean isApplicationValidationRequired()

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

isInitialTargetView

boolean isInitialTargetView()

Indicates whether or not the initial target of this use case is a view or not.

isRegistrationUseCase

boolean isRegistrationUseCase()

Indicates whether or not this is a front-end registration use case. Only one use case can be labeled as a 'registration' use case.

isValidationRequired

boolean isValidationRequired()

Indicates whether or not at least one parameter in this use-case require validation.

isViewHasNameOfUseCase

boolean isViewHasNameOfUseCase()

Indicates whether or not at least one view in the use case has the same name as this use case.