org.andromda.cartridges.jsf.metafacades

Interface JSFView

All Superinterfaces:

ActionStateFacade, FrontEndActionState, FrontEndView, ModelElementFacade, StateFacade, StateVertexFacade

All Known Implementing Classes:

JSFViewLogic, JSFViewLogicImpl

public interface JSFView
extends FrontEndView

Represents a JSF view for a front-end application. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods

Modifier and Type	Method and Description
List<JSFAction>	getActionForwards() All those forwards that are actions.
List<JSFParameter>	getBackingValueVariables() All variables that have backing value.
String	getDocumentationKey() A resource message key suited for the page's documentation.
String	getDocumentationValue() A resource message value suited for the view's documentation.
List<JSFAction>	getFormActions() All actions that have forms associated with them.
String	getFormKey() The key that stores the form in which information is passed from one action to another.
List<JSFForward>	getForwards() Gets the forwards which can be targgeted from this view.
String	getFromOutcome() The name that corresponds to the from-outcome in an navigational rule.
String	getFullyQualifiedPopulator() The fully qualified name of this view's form populator.
String	getMessageKey() The default resource message key for this view.
String	getMessageValue() A displayable version of this view's name.
String	getPath() The full path of the view resources (i.e.
String	getPopulator() The name of the form populator for this view.
String	getPopulatorPath() The path to the form populator.
String	getTitleKey() A resource message key suited for the view's title.
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	isNeedsFileUpload() TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFView.needsFileUpload
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, getServiceCalls, 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, getIncomings, getOutgoings, getPartition, getStateMachine, isStateVertexFacadeMetaType

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

isJSFViewMetaType

boolean isJSFViewMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

boolean always true

getActionForwards

List<JSFAction> getActionForwards()

All those forwards that are actions.

Returns:

List

getBackingValueVariables

List<JSFParameter> getBackingValueVariables()

All variables that have backing value.

Returns:

List

getDocumentationKey

String getDocumentationKey()

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

Returns:

String

getDocumentationValue

String getDocumentationValue()

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

Returns:

String

getFormActions

List<JSFAction> getFormActions()

All actions that have forms associated with them.

Returns:

List

getFormKey

String getFormKey()

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

Returns:

String

getForwards

List<JSFForward> getForwards()

Gets the forwards which can be targgeted from this view.

Returns:

List

getFromOutcome

String getFromOutcome()

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

Returns:

String

getFullyQualifiedPopulator

String getFullyQualifiedPopulator()

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

Returns:

String

getMessageKey

String getMessageKey()

The default resource message key for this view.

Returns:

String

getMessageValue

String getMessageValue()

A displayable version of this view's name.

Returns:

String

getPath

String getPath()

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

Returns:

String

getPopulator

String getPopulator()

The name of the form populator for this view.

Returns:

String

getPopulatorPath

String getPopulatorPath()

The path to the form populator.

Returns:

String

getTitleKey

String getTitleKey()

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

Returns:

String

getTitleValue

String getTitleValue()

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

Returns:

String

isHasNameOfUseCase

boolean isHasNameOfUseCase()

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

Returns:

boolean

isNeedsFileUpload

boolean isNeedsFileUpload()

TODO: Model Documentation for org.andromda.cartridges.jsf.metafacades.JSFView.needsFileUpload

Returns:

boolean

isNonTableVariablesPresent

boolean isNonTableVariablesPresent()

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

Returns:

boolean

isPopulatorRequired

boolean isPopulatorRequired()

Indicates if a populator is required for this view.

Returns:

boolean

isPopup

boolean isPopup()

Indicates if this view represents a popup.

Returns:

boolean

isValidationRequired

boolean isValidationRequired()

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

Returns:

boolean