org.andromda.cartridges.jsf2.metafacades

Interface JSFUseCase

All Superinterfaces:

ClassifierFacade, FrontEndUseCase, GeneralizableElementFacade, ModelElementFacade, NamespaceFacade, UseCaseFacade

All Known Implementing Classes:

JSFUseCaseLogic, JSFUseCaseLogicImpl

public interface JSFUseCase
extends FrontEndUseCase

Represents a JSF use case. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
String	getActionClassName() The name of the action class that forwards to this use case.
List<JSFAction>	getActionForwards() All forwards in this use case that are represented as actions.
String	getActionRoles() TODO: Model Documentation for JSFUseCase.getActionRoles
List	getAllForwards() Constains all forwards includes regular FrontEndForwards and all actiion forwards.
Map	getAllMessages() A map with keys sorted alphabetically, normalized across all different use-cases, views, etc.
Collection<JSFView>	getAllViews() All views for the application (not just the ones belonging to this use case).
String	getControllerAction() The name of the action on the controller that executions this use case.
String	getFormKey() The key under which to store the action form passed along in this in this use-case.
String	getForwardName() The name that will cause a forward to use case.
List<JSFForward>	getForwards() All forwards contained in this use case.
String	getForwardsClassName() The name of the class that stores all the forwards paths.
String	getFullyQualifiedActionClassName() The fully qualified name of the action class that forwards to this use case.
String	getFullyQualifiedActionClassPath() The fully qualified path to the action class that forwards to this use case.
String	getInitialTargetPath() The path of the initial target going into this use case.
Collection	getNavigationChildren() TODO: Model Documentation for JSFUseCase.getNavigationChildren
Collection	getNavigationParents() TODO: Model Documentation for JSFUseCase.getNavigationParents
Collection	getNavigationRules() Retrieves all navigation rules for the faces-config.xml
String	getPath() The path to which this use case points.
String	getPathRoot() The root path for this use case (this is the path the directory containing the use case's resources).
String	getPortletEditForwardName() The forward name for the portlet 'edit' page.
String	getPortletEditPath() The path to the portlet 'edit' page.
String	getPortletHelpForwardName() The forward name for the portlet 'help' page.
String	getPortletHelpPath() The path to the 'help' page of the portlet.
String	getPortletViewForwardName() The forward name for the portlet 'view' page.
String	getPortletViewPath() The path to the portlet 'view' page.
JSFPortletPreferences	getPreferences() Any portlet preferences associated to this use case.
List<JSFUseCase>	getRegistrationUseCases() All use cases that are labled as registration use cases.
String	getTitleKey() The title message key for this use-case.
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, 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

isJSFUseCaseMetaType

boolean isJSFUseCaseMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getActionClassName

String getActionClassName()

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

Returns:

String

getActionForwards

List<JSFAction> getActionForwards()

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

Returns:

List

getActionRoles

String getActionRoles()

TODO: Model Documentation for JSFUseCase.getActionRoles

Returns:

String

getAllForwards

List getAllForwards()

Constains all forwards includes regular FrontEndForwards and all actiion forwards.

Returns:

List

getAllMessages

Map getAllMessages()

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

Returns:

Map

getAllViews

Collection<JSFView> getAllViews()

All views for the application (not just the ones belonging to this use case).

Returns:

Collection

getControllerAction

String getControllerAction()

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

Returns:

String

getFormKey

String getFormKey()

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

Returns:

String

getForwardName

String getForwardName()

The name that will cause a forward to use case.

Returns:

String

getForwards

List<JSFForward> getForwards()

All forwards contained in this use case.

Returns:

List

getForwardsClassName

String getForwardsClassName()

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

Returns:

String

getFullyQualifiedActionClassName

String getFullyQualifiedActionClassName()

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

Returns:

String

getFullyQualifiedActionClassPath

String getFullyQualifiedActionClassPath()

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

Returns:

String

getInitialTargetPath

String getInitialTargetPath()

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

Returns:

String

getNavigationChildren

Collection getNavigationChildren()

TODO: Model Documentation for JSFUseCase.getNavigationChildren

Returns:

Collection

getNavigationParents

Collection getNavigationParents()

TODO: Model Documentation for JSFUseCase.getNavigationParents

Returns:

Collection

getNavigationRules

Collection getNavigationRules()

Retrieves all navigation rules for the faces-config.xml

Returns:

Collection

getPath

String getPath()

The path to which this use case points.

Returns:

String

getPathRoot

String getPathRoot()

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

Returns:

String

getPortletEditForwardName

String getPortletEditForwardName()

The forward name for the portlet 'edit' page.

Returns:

String

getPortletEditPath

String getPortletEditPath()

The path to the portlet 'edit' page.

Returns:

String

getPortletHelpForwardName

String getPortletHelpForwardName()

The forward name for the portlet 'help' page.

Returns:

String

getPortletHelpPath

String getPortletHelpPath()

The path to the 'help' page of the portlet.

Returns:

String

getPortletViewForwardName

String getPortletViewForwardName()

The forward name for the portlet 'view' page.

Returns:

String

getPortletViewPath

String getPortletViewPath()

The path to the portlet 'view' page.

Returns:

String

getPreferences

JSFPortletPreferences getPreferences()

Any portlet preferences associated to this use case.

Returns:

JSFPortletPreferences

getRegistrationUseCases

List<JSFUseCase> getRegistrationUseCases()

All use cases that are labled as registration use cases.

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

isApplicationValidationRequired

boolean isApplicationValidationRequired()

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

Returns:

boolean

isInitialTargetView

boolean isInitialTargetView()

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

Returns:

boolean

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.

Returns:

boolean

isValidationRequired

boolean isValidationRequired()

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

Returns:

boolean

isViewHasNameOfUseCase

boolean isViewHasNameOfUseCase()

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

Returns:

boolean