org.andromda.cartridges.jsf.metafacades
Interface JSFParameter

All Superinterfaces:

org.andromda.metafacades.uml.FrontEndParameter, org.andromda.metafacades.uml.ModelElementFacade, org.andromda.metafacades.uml.ParameterFacade

All Known Implementing Classes:

JSFParameterLogic, JSFParameterLogicImpl

public interface JSFParameter
extends org.andromda.metafacades.uml.FrontEndParameter

Represents a parameter in a JSF front-end.

Metafacade interface to be used by AndroMDA cartridges.

Method Summary

java.util.Collection	getAttributes() All attributes belonging to this parameter's type.
java.lang.String	getBackingListName() The backing list name for this parameter.
java.lang.String	getBackingValueName() The name of the backing value for this parameter (only used with collections and arrays that are input type table).
java.lang.String	getDateFormatter() The name of the date formatter for this parameter (if this parameter represents a date).
java.lang.String	getDocumentationKey() A resource message key suited for the parameter's documentation.
java.lang.String	getDocumentationValue() A resource message value suited for the parameter's documentation.
java.lang.String	getDummyValue() The dummy value for this parameter.
java.lang.String	getFormat() If this parameter represents a date or time this method will return the format in which it must be represented.
java.lang.String	getFormAttributeSetProperty() The name of the property used for indicating whether or not a form attribute has been set at least once.
java.lang.String	getInputTableIdentifierColumns() A comma seperated list of the input table identifier columns (these are the columns that uniquely define a row in an input table).
java.lang.String	getLabelListName() The name of the label list for this parameter.
java.lang.String	getMessageKey() The default message key for this parameter.
java.lang.String	getMessageValue() The default message value for this parameter.
java.util.Collection	getNavigableAssociationEnds() All navigation association ends belonging to this parameter's type.
java.util.List	getTableColumnActions(java.lang.String columnName) Those actions that are targetting the given column, only makes sense when this parameter represents a table view-variable.
java.lang.String	getTableColumnMessageKey(java.lang.String columnName)
java.lang.String	getTableColumnMessageValue(java.lang.String columnName)
java.util.List	getTableFormActions() Actions used when submitting forms for this table.
java.util.List	getTableHyperlinkActions() Actions that are working with this table and are to be represented as hyperlinks.
java.lang.String	getTableSortAscendingProperty() The name of the property that Indicates whether or not the table should be sorted ascending (if this parameter represents a table).
java.lang.String	getTableSortColumnProperty() The name of the property storing the column to sort by if this parameter represents a table.
java.lang.String	getTimeFormatter() The name of the time formatter (if this parameter represents a time).
java.util.Collection	getValidatorArgs(java.lang.String validatorType) Gets the arguments for this parameter's validators.
java.util.Collection	getValidatorTypes() All the validator types for this parameter.
java.util.Collection	getValidatorVars() The validator variables.
java.lang.String	getValidWhen() The validator's 'validwhen' value, this is useful when the validation of a parameter depends on the validation of others.
java.lang.String	getValueListDummyValue() The dummy value for a value list.
java.lang.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, getEvent, getGetterName, getLower, getOperation, getSetterName, getType, getUpper, isDefaultValuePresent, isInoutParameter, isInParameter, isOutParameter, isParameterFacadeMetaType, isReadable, isRequired, isReturn, isWritable

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

isJSFParameterMetaType

boolean isJSFParameterMetaType()

Indicates the metafacade type (used for metafacade mappings).

Returns:

always true

getAttributes

java.util.Collection getAttributes()

All attributes belonging to this parameter's type.

getBackingListName

java.lang.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).

getBackingValueName

java.lang.String getBackingValueName()

The name of the backing value for this parameter (only used with collections and arrays that are input type table).

getDateFormatter

java.lang.String getDateFormatter()

The name of the date formatter for this parameter (if this parameter represents a date).

getDocumentationKey

java.lang.String getDocumentationKey()

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

getDocumentationValue

java.lang.String getDocumentationValue()

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

getDummyValue

java.lang.String getDummyValue()

The dummy value for this parameter. The dummy value is used for setting the dummy information when dummyData is enabled.

getFormAttributeSetProperty

java.lang.String getFormAttributeSetProperty()

The name of the property used for indicating whether or not a form attribute has been set at least once.

getFormat

java.lang.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.

getInputTableIdentifierColumns

java.lang.String getInputTableIdentifierColumns()

A comma seperated list of the input table identifier columns (these are the columns that uniquely define a row in an input table).

getLabelListName

java.lang.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).

getMessageKey

java.lang.String getMessageKey()

The default message key for this parameter.

getMessageValue

java.lang.String getMessageValue()

The default message value for this parameter.

getNavigableAssociationEnds

java.util.Collection getNavigableAssociationEnds()

All navigation association ends belonging to this parameter's type.

getTableColumnActions

java.util.List getTableColumnActions(java.lang.String columnName)

Those actions that are targetting the given column, only makes sense when this parameter represents a table view-variable.

getTableColumnMessageKey

java.lang.String getTableColumnMessageKey(java.lang.String columnName)

getTableColumnMessageValue

java.lang.String getTableColumnMessageValue(java.lang.String columnName)

getTableFormActions

java.util.List 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.

getTableHyperlinkActions

java.util.List 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.

getTableSortAscendingProperty

java.lang.String getTableSortAscendingProperty()

The name of the property that Indicates whether or not the table should be sorted ascending (if this parameter represents a table).

getTableSortColumnProperty

java.lang.String getTableSortColumnProperty()

The name of the property storing the column to sort by if this parameter represents a table.

getTimeFormatter

java.lang.String getTimeFormatter()

The name of the time formatter (if this parameter represents a time).

getValidWhen

java.lang.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.

getValidatorArgs

java.util.Collection getValidatorArgs(java.lang.String validatorType)

Gets the arguments for this parameter's validators.

getValidatorTypes

java.util.Collection getValidatorTypes()

All the validator types for this parameter.

getValidatorVars

java.util.Collection getValidatorVars()

The validator variables.

getValueListDummyValue

java.lang.String getValueListDummyValue()

The dummy value for a value list.

getValueListName

java.lang.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).

isBackingValueRequired

boolean isBackingValueRequired()

Indicates if a backing value is required for this parameter.

isComplex

boolean isComplex()

Indicates if this parameter is 'complex', that is: its of a complex type (has at least one attribute or association).

isEqualValidator

boolean isEqualValidator()

Indicates whether or not this parameter uses the equal validator.

isInputCheckbox

boolean isInputCheckbox()

Indicates if this parameter represents a checkbox widget.

isInputFile

boolean isInputFile()

Indicates whether or not this is a file input type.

isInputHidden

boolean isInputHidden()

Indicates whether or not this parameter represents a hidden input widget.

isInputMultibox

boolean isInputMultibox()

Indicates whether or not this type represents an input multibox.

isInputRadio

boolean isInputRadio()

Indicates whether or not this parameter should be rendered as an input radio widget.

isInputSecret

boolean isInputSecret()

Indicates whether or not this parameter represents an input "secret" widget (i.e. password).

isInputSelect

boolean isInputSelect()

Indicates whether or not this parameter represents an input select widget.

isInputTable

boolean isInputTable()

Indicates whether or not this is an table input type.

isInputText

boolean isInputText()

Indicates whether or not this parameter should be rendered as a text input widget.

isInputTextarea

boolean isInputTextarea()

Indicates if this parameter represents as an input text area widget.

isPageableTable

boolean isPageableTable()

Whether or not the parameter is a "pageable table", that is a table that supports paging (i.e. DB paging).

isPlaintext

boolean isPlaintext()

Indicates whether or not this field should be rendered as plain text (not as a widget).

isReadOnly

boolean isReadOnly()

Indicates if this parameter can only be read and not modified.

isReset

boolean isReset()

Indicates if this parameter's value should be reset or not after an action has been performed with this parameter.

isSelectable

boolean isSelectable()

Indicates whether or not this parameter is selectable or not (that is: it can be selected from a list of values).

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.

isValidationRequired

boolean isValidationRequired()

Indicates whether or not this parameter requires some kind of validation (the collection of validator types is not empty).