org.andromda.cartridges.jsf.metafacades
Interface JSFView

All Superinterfaces:
org.andromda.metafacades.uml.ActionStateFacade, org.andromda.metafacades.uml.FrontEndActionState, org.andromda.metafacades.uml.FrontEndView, org.andromda.metafacades.uml.ModelElementFacade, org.andromda.metafacades.uml.StateFacade, org.andromda.metafacades.uml.StateVertexFacade
All Known Implementing Classes:
JSFViewLogic, JSFViewLogicImpl

public interface JSFView
extends org.andromda.metafacades.uml.FrontEndView

Represents a JSF view for a front-end application.

Metafacade interface to be used by AndroMDA cartridges.


Method Summary
 java.util.List getActionForwards()
           All those forwards that are actions.
 java.util.List getBackingValueVariables()
           All variables that have backing value.
 java.lang.String getDocumentationKey()
           A resource message key suited for the page's documentation.
 java.lang.String getDocumentationValue()
           A resource message value suited for the view's documentation.
 java.util.List getFormActions()
           All actions that have forms associated with them.
 java.lang.String getFormKey()
           The key that stores the form in which information is passed from one action to another.
 java.util.List getForwards()
           Gets the forwards which can be targgeted from this view.
 java.lang.String getFromOutcome()
           The name that corresponds to the from-outcome in an navigational rule.
 java.lang.String getFullyQualifiedPopulator()
           The fully qualified name of this view's form populator.
 java.lang.String getMessageKey()
           The default resource message key for this view.
 java.lang.String getMessageValue()
           A displayable version of this view's name.
 java.lang.String getPath()
           The full path of the view resources (i.e. the JSP page).
 java.lang.String getPopulator()
           The name of the form populator for this view.
 java.lang.String getPopulatorPath()
           The path to the form populator.
 java.lang.String getTitleKey()
           A resource message key suited for the view's title.
 java.lang.String getTitleValue()
           A default resource message value suited for the page's title.
 boolean isHasNameOfUseCase()
           Indicates whether or not this view has the same name as the use case in which it is contained.
 boolean isJSFViewMetaType()
          Indicates the metafacade type (used for metafacade mappings).
 boolean isNonTableVariablesPresent()
           Indicates whether or not any non-table view variables are present in this view.
 boolean isPopulatorRequired()
           Indicates if a populator is required for this view.
 boolean isPopup()
           Indicates if this view represents a popup.
 boolean isValidationRequired()
           Indicates whether or not at least one parameter of an outgoing action in this view requires validation.
 
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, 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, getIncoming, getOutgoing, getPartition, getStateMachine, isStateVertexFacadeMetaType
 
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

isJSFViewMetaType

boolean isJSFViewMetaType()
Indicates the metafacade type (used for metafacade mappings).

Returns:
always true

getActionForwards

java.util.List getActionForwards()

All those forwards that are actions.


getBackingValueVariables

java.util.List getBackingValueVariables()

All variables that have backing value.


getDocumentationKey

java.lang.String getDocumentationKey()

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


getDocumentationValue

java.lang.String getDocumentationValue()

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


getFormActions

java.util.List getFormActions()

All actions that have forms associated with them.


getFormKey

java.lang.String getFormKey()

The key that stores the form in which information is passed from one action to another.


getForwards

java.util.List getForwards()

Gets the forwards which can be targgeted from this view.


getFromOutcome

java.lang.String getFromOutcome()

The name that corresponds to the from-outcome in an navigational rule.


getFullyQualifiedPopulator

java.lang.String getFullyQualifiedPopulator()

The fully qualified name of this view's form populator.


getMessageKey

java.lang.String getMessageKey()

The default resource message key for this view.


getMessageValue

java.lang.String getMessageValue()

A displayable version of this view's name.


getPath

java.lang.String getPath()

The full path of the view resources (i.e. the JSP page).


getPopulator

java.lang.String getPopulator()

The name of the form populator for this view.


getPopulatorPath

java.lang.String getPopulatorPath()

The path to the form populator.


getTitleKey

java.lang.String getTitleKey()

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


getTitleValue

java.lang.String getTitleValue()

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


isHasNameOfUseCase

boolean isHasNameOfUseCase()

Indicates whether or not this view has the same name as the use case in which it is contained.


isNonTableVariablesPresent

boolean isNonTableVariablesPresent()

Indicates whether or not any non-table view variables are present in this view.


isPopulatorRequired

boolean isPopulatorRequired()

Indicates if a populator is required for this view.


isPopup

boolean isPopup()

Indicates if this view represents a popup.


isValidationRequired

boolean isValidationRequired()

Indicates whether or not at least one parameter of an outgoing action in this view requires validation.



Copyright © 2003-2008 AndroMDA.org. All Rights Reserved.