JSFParameter (AndroMDA JSF2 Cartridge 3.5-SNAPSHOT API)

All Superinterfaces:

FrontEndParameter, ModelElementFacade, ParameterFacade

All Known Implementing Classes:

JSFParameterLogic, JSFParameterLogicImpl
```
public interface JSFParameter
extends FrontEndParameter
```
Represents a parameter in a JSF front-end. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods
Modifier and Type	Method and Description
`Collection`	`getAnnotations()` All the annotations for this parameter.
`Collection`	`getAttributes()` All attributes belonging to this parameter's type.
`String`	`getBackingListName()` The backing list name for this parameter.
`String`	`getBackingValueName()` The name of the backing value for this parameter (only used with collections and arrays that are input type table).
`String`	`getDateFormatter()` The name of the date formatter for this parameter (if this parameter represents a date).
`String`	`getDocumentationKey()` A resource message key suited for the parameter's documentation.
`String`	`getDocumentationValue()` A resource message value suited for the parameter's documentation.
`String`	`getDummyValue()` The dummy value for this parameter.
`String`	`getFormat()` If this parameter represents a date or time this method will return the format in which it must be represented.
`String`	`getFormAttributeSetProperty()` The name of the property used for indicating whether or not a form attribute has been set at least once.
`String`	`getInputTableIdentifierColumns()` A comma separated list of the input table identifier columns (these are the columns that uniquely define a row in an input table).
`String`	`getLabelListName()` The name of the label list for this parameter.
`String`	`getMaxLength()` The max length allowed in the input component
`String`	`getMessageKey()` The default message key for this parameter.
`String`	`getMessageValue()` The default message value for this parameter.
`Collection<AssociationEndFacade>`	`getNavigableAssociationEnds()` All navigation association ends belonging to this parameter's type.
`List<JSFAction>`	`getTableActions()` Actions used when submitting forms for this table.
`List`	`getTableColumnActions(String columnName)` Those actions that are targetting the given column, only makes sense when this parameter represents a table view-variable.
`String`	`getTableColumnMessageKey(String columnName)` TODO: Model Documentation for org.andromda.cartridges.jsf2.metafacades.JSFParameter.getTableColumnMessageKey
`String`	`getTableColumnMessageValue(String columnName)` TODO: Model Documentation for org.andromda.cartridges.jsf2.metafacades.JSFParameter.getTableColumnMessageValue
`List<JSFAction>`	`getTableFormActions()` Actions used when submitting forms for this table.
`List<JSFAction>`	`getTableHyperlinkActions()` Actions that are working with this table and are to be represented as hyperlinks.
`String`	`getTableSortAscendingProperty()` The name of the property that Indicates whether or not the table should be sorted ascending (if this parameter represents a table).
`String`	`getTableSortColumnProperty()` The name of the property storing the column to sort by if this parameter represents a table.
`String`	`getTimeFormatter()` The name of the time formatter (if this parameter represents a time).
`Collection`	`getValidatorArgs(String validatorType)` Gets the arguments for this parameter's validators.
`Collection`	`getValidatorTypes()` All the validator types for this parameter.
`Collection`	`getValidatorVars()` The validator variables.
`String`	`getValidWhen()` The validator's 'validwhen' value, this is useful when the validation of a parameter depends on the validation of others.
`String`	`getValueListDummyValue()` The dummy value for a value list.
`String`	`getValueListName()` Stores the name of the value list for this parameter; this list stores the possible values that this parameter may be (typically used for the values of a drop-down select list).
`boolean`	`isBackingValueRequired()` Indicates if a backing value is required for this parameter.
`boolean`	`isComplex()` Indicates if this parameter is 'complex', that is: its of a complex type (has at least one attribute or association).
`boolean`	`isEqualValidator()` Indicates whether or not this parameter uses the equal validator.
`boolean`	`isInputCheckbox()` Indicates if this parameter represents a checkbox widget.
`boolean`	`isInputFile()` Indicates whether or not this is a file input type.
`boolean`	`isInputHidden()` Indicates whether or not this parameter represents a hidden input widget.
`boolean`	`isInputMultibox()` Indicates whether or not this type represents an input multibox.
`boolean`	`isInputRadio()` Indicates whether or not this parameter should be rendered as an input radio widget.
`boolean`	`isInputSecret()` Indicates whether or not this parameter represents an input "secret" widget (i.e.
`boolean`	`isInputSelect()` Indicates whether or not this parameter represents an input select widget.
`boolean`	`isInputTable()` Indicates whether or not this is an table input type.
`boolean`	`isInputText()` Indicates whether or not this parameter should be rendered as a text input widget.
`boolean`	`isInputTextarea()` Indicates if this parameter represents as an input text area widget.
`boolean`	`isJSFParameterMetaType()` Indicates the metafacade type (used for metafacade mappings).
`boolean`	`isPageableTable()` Whether or not the parameter is a "pageable table", that is a table that supports paging (i.e.
`boolean`	`isPlaintext()` Indicates whether or not this field should be rendered as plain text (not as a widget).
`boolean`	`isReadOnly()` Indicates if this parameter can only be read and not modified.
`boolean`	`isReset()` Indicates if this parameter's value should be reset or not after an action has been performed with this parameter.
`boolean`	`isSelectable()` Indicates whether or not this parameter is selectable or not (that is: it can be selected from a list of values).
`boolean`	`isStrictDateFormat()` Indicates where or not the date format is to be strictly respected.
`boolean`	`isValidationRequired()` Indicates whether or not this parameter requires some kind of validation (the collection of validator types is not empty).

Methods inherited from interface org.andromda.metafacades.uml.FrontEndParameter
getAction, getControllerOperation, getTableAttributeNames, getTableColumnNames, getTableColumns, getView, isActionParameter, isContainedInFrontEndUseCase, isControllerOperationArgument, isFrontEndParameterMetaType, isTable

Methods inherited from interface org.andromda.metafacades.uml.ParameterFacade
getDefaultValue, getEffect, getEvent, getGetterName, getGetterSetterTypeName, getGetterSetterTypeNameImpl, getLower, getOperation, getSetterName, getType, getUpper, isDefaultValuePresent, isException, isInoutParameter, isInParameter, isMany, isOrdered, isOutParameter, isParameterFacadeMetaType, isReadable, isRequired, isReturn, isUnique, isWritable

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
  - isJSFParameterMetaType
```
boolean isJSFParameterMetaType()
```
    Indicates the metafacade type (used for metafacade mappings).
    
    Returns:
    boolean always true
  - getAnnotations
```
Collection getAnnotations()
```
    All the annotations for this parameter.
    
    Returns:
    Collection
  - getAttributes
```
Collection getAttributes()
```
    All attributes belonging to this parameter's type.
    
    Returns:
    Collection
  - getBackingListName
```
String getBackingListName()
```
    The backing list name for this parameter. This is useful if you want to be able to select the parameter value from a list (i.e. a drop-down select input type).
    
    Returns:
    String
  - getBackingValueName
```
String getBackingValueName()
```
    The name of the backing value for this parameter (only used with collections and arrays that are input type table).
    
    Returns:
    String
  - getDateFormatter
```
String getDateFormatter()
```
    The name of the date formatter for this parameter (if this parameter represents a date).
    
    Returns:
    String
  - getDocumentationKey
```
String getDocumentationKey()
```
    A resource message key suited for the parameter's documentation.
    
    Returns:
    String
  - getDocumentationValue
```
String getDocumentationValue()
```
    A resource message value suited for the parameter's documentation.
    
    Returns:
    String
  - getDummyValue
```
String getDummyValue()
```
    The dummy value for this parameter. The dummy value is used for setting the dummy information when dummyData is enabled.
    
    Returns:
    String
  - getFormAttributeSetProperty
```
String getFormAttributeSetProperty()
```
    The name of the property used for indicating whether or not a form attribute has been set at least once.
    
    Returns:
    String
  - getFormat
```
String getFormat()
```
    If this parameter represents a date or time this method will return the format in which it must be represented. In the event this format has not been specified by the any tagged value the default will be used.
    
    Returns:
    String
  - getInputTableIdentifierColumns
```
String getInputTableIdentifierColumns()
```
    A comma separated list of the input table identifier columns (these are the columns that uniquely define a row in an input table).
    
    Returns:
    String
  - getLabelListName
```
String getLabelListName()
```
    The name of the label list for this parameter. The label list name is the name of the list storing the labels for the possible values of this parameter (typically used for the labels of a drop-down select lists).
    
    Returns:
    String
  - getMaxLength
```
String getMaxLength()
```
    The max length allowed in the input component
    
    Returns:
    String
  - getMessageKey
```
String getMessageKey()
```
    The default message key for this parameter.
    
    Returns:
    String
  - getMessageValue
```
String getMessageValue()
```
    The default message value for this parameter.
    
    Returns:
    String
  - getNavigableAssociationEnds
```
Collection<AssociationEndFacade> getNavigableAssociationEnds()
```
    All navigation association ends belonging to this parameter's type.
    
    Returns:
    Collection
  - getTableActions
```
List<JSFAction> getTableActions()
```
    Actions used when submitting forms for this table. It only makes sense to call this property on parameters that represent a table page-variable.
    
    Returns:
    List
  - getTableColumnActions
```
List getTableColumnActions(String columnName)
```
    Those actions that are targetting the given column, only makes sense when this parameter represents a table view-variable.
    
    Parameters:
    columnName - String
    
    Returns:
    List
  - getTableColumnMessageKey
```
String getTableColumnMessageKey(String columnName)
```
    TODO: Model Documentation for org.andromda.cartridges.jsf2.metafacades.JSFParameter.getTableColumnMessageKey
    
    Parameters:
    columnName - String
    
    Returns:
    String
  - getTableColumnMessageValue
```
String getTableColumnMessageValue(String columnName)
```
    TODO: Model Documentation for org.andromda.cartridges.jsf2.metafacades.JSFParameter.getTableColumnMessageValue
    
    Parameters:
    columnName - String
    
    Returns:
    String
  - getTableFormActions
```
List<JSFAction> getTableFormActions()
```
    Actions used when submitting forms for this table. Table actions that are hyperlinks are not included. It only makes sense to call this property on parameters that represent a table page-variable.
    
    Returns:
    List
  - getTableHyperlinkActions
```
List<JSFAction> getTableHyperlinkActions()
```
    Actions that are working with this table and are to be represented as hyperlinks. This only makes sense on a parameter that represents a table page variable.
    
    Returns:
    List
  - getTableSortAscendingProperty
```
String getTableSortAscendingProperty()
```
    The name of the property that Indicates whether or not the table should be sorted ascending (if this parameter represents a table).
    
    Returns:
    String
  - getTableSortColumnProperty
```
String getTableSortColumnProperty()
```
    The name of the property storing the column to sort by if this parameter represents a table.
    
    Returns:
    String
  - getTimeFormatter
```
String getTimeFormatter()
```
    The name of the time formatter (if this parameter represents a time).
    
    Returns:
    String
  - getValidWhen
```
String getValidWhen()
```
    The validator's 'validwhen' value, this is useful when the validation of a parameter depends on the validation of others. See the apache commons-validator documentation for more information.
    
    Returns:
    String
  - getValidatorArgs
```
Collection getValidatorArgs(String validatorType)
```
    Gets the arguments for this parameter's validators.
    
    Parameters:
    validatorType - String
    
    Returns:
    Collection
  - getValidatorTypes
```
Collection getValidatorTypes()
```
    All the validator types for this parameter.
    
    Returns:
    Collection
  - getValidatorVars
```
Collection getValidatorVars()
```
    The validator variables.
    
    Returns:
    Collection
  - getValueListDummyValue
```
String getValueListDummyValue()
```
    The dummy value for a value list.
    
    Returns:
    String
  - getValueListName
```
String getValueListName()
```
    Stores the name of the value list for this parameter; this list stores the possible values that this parameter may be (typically used for the values of a drop-down select list).
    
    Returns:
    String
  - isBackingValueRequired
```
boolean isBackingValueRequired()
```
    Indicates if a backing value is required for this parameter.
    
    Returns:
    boolean
  - isComplex
```
boolean isComplex()
```
    Indicates if this parameter is 'complex', that is: its of a complex type (has at least one attribute or association).
    
    Returns:
    boolean
  - isEqualValidator
```
boolean isEqualValidator()
```
    Indicates whether or not this parameter uses the equal validator.
    
    Returns:
    boolean
  - isInputCheckbox
```
boolean isInputCheckbox()
```
    Indicates if this parameter represents a checkbox widget.
    
    Returns:
    boolean
  - isInputFile
```
boolean isInputFile()
```
    Indicates whether or not this is a file input type.
    
    Returns:
    boolean
  - isInputHidden
```
boolean isInputHidden()
```
    Indicates whether or not this parameter represents a hidden input widget.
    
    Returns:
    boolean
  - isInputMultibox
```
boolean isInputMultibox()
```
    Indicates whether or not this type represents an input multibox.
    
    Returns:
    boolean
  - isInputRadio
```
boolean isInputRadio()
```
    Indicates whether or not this parameter should be rendered as an input radio widget.
    
    Returns:
    boolean
  - isInputSecret
```
boolean isInputSecret()
```
    Indicates whether or not this parameter represents an input "secret" widget (i.e. password).
    
    Returns:
    boolean
  - isInputSelect
```
boolean isInputSelect()
```
    Indicates whether or not this parameter represents an input select widget.
    
    Returns:
    boolean
  - isInputTable
```
boolean isInputTable()
```
    Indicates whether or not this is an table input type.
    
    Returns:
    boolean
  - isInputText
```
boolean isInputText()
```
    Indicates whether or not this parameter should be rendered as a text input widget.
    
    Returns:
    boolean
  - isInputTextarea
```
boolean isInputTextarea()
```
    Indicates if this parameter represents as an input text area widget.
    
    Returns:
    boolean
  - isPageableTable
```
boolean isPageableTable()
```
    Whether or not the parameter is a "pageable table", that is a table that supports paging (i.e. DB paging).
    
    Returns:
    boolean
  - isPlaintext
```
boolean isPlaintext()
```
    Indicates whether or not this field should be rendered as plain text (not as a widget).
    
    Returns:
    boolean
  - isReadOnly
```
boolean isReadOnly()
```
    Indicates if this parameter can only be read and not modified.
    
    Returns:
    boolean
  - isReset
```
boolean isReset()
```
    Indicates if this parameter's value should be reset or not after an action has been performed with this parameter.
    
    Returns:
    boolean
  - isSelectable
```
boolean isSelectable()
```
    Indicates whether or not this parameter is selectable or not (that is: it can be selected from a list of values).
    
    Returns:
    boolean
  - isStrictDateFormat
```
boolean isStrictDateFormat()
```
    Indicates where or not the date format is to be strictly respected. Otherwise the date formatter used for the representation of this date is to be set to lenient.
    
    Returns:
    boolean
  - isValidationRequired
```
boolean isValidationRequired()
```
    Indicates whether or not this parameter requires some kind of validation (the collection of validator types is not empty).
    
    Returns:
    boolean

Interface JSFParameter

Method Summary

Methods inherited from interface org.andromda.metafacades.uml.FrontEndParameter

Methods inherited from interface org.andromda.metafacades.uml.ParameterFacade

Methods inherited from interface org.andromda.metafacades.uml.ModelElementFacade

Method Detail

isJSFParameterMetaType

getAnnotations

getAttributes

getBackingListName

getBackingValueName

getDateFormatter

getDocumentationKey

getDocumentationValue

getDummyValue

getFormAttributeSetProperty

getFormat

getInputTableIdentifierColumns

getLabelListName

getMaxLength

getMessageKey

getMessageValue

getNavigableAssociationEnds

getTableActions

getTableColumnActions

getTableColumnMessageKey

getTableColumnMessageValue

getTableFormActions

getTableHyperlinkActions

getTableSortAscendingProperty

getTableSortColumnProperty

getTimeFormatter

getValidWhen

getValidatorArgs

getValidatorTypes

getValidatorVars

getValueListDummyValue

getValueListName

isBackingValueRequired

isComplex

isEqualValidator

isInputCheckbox

isInputFile

isInputHidden

isInputMultibox

isInputRadio

isInputSecret

isInputSelect

isInputTable

isInputText

isInputTextarea

isPageableTable

isPlaintext

isReadOnly

isReset

isSelectable

isStrictDateFormat

isValidationRequired