StrutsParameter (AndroMDA BPM4Struts Cartridge 3.5-SNAPSHOT API)

All Superinterfaces:

FrontEndParameter, ModelElementFacade, ParameterFacade

All Known Implementing Classes:

StrutsParameterLogic, StrutsParameterLogicImpl
```
public interface StrutsParameter
extends FrontEndParameter
```
A Struts parameter is an object communicated between the client and the server. Typically form beans encapsulate such parameters. Metafacade interface to be used by AndroMDA cartridges.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`getBackingListName()` The backing list name for this parameter.
`String`	`getCollectionImplementationType()` If this parameter is a collection type, this property will represent the fully qualified name of a class suitable for implementation.
`String`	`getDateFormat()` If this parameter represents a date this method will return the format in which it must be represented.
`String`	`getDocumentationKey()` The key to lookup the documentation for this parameter.
`String`	`getDocumentationValue()` The documentation for this parameter, formatted to be inserted into a resource bundle.
`Integer`	`getFieldColumnCount()` The number of columns for this field, null if default browser value is desired.
`Integer`	`getFieldRowCount()` The number of rows for this field, null if default browser value is desired.
`List<StrutsParameter>`	`getFormFields()` If this is a controller operation argument these form fields will represent the form fields for all actions deferring to the controller operation.
`StrutsJsp`	`getJsp()` Represents the jsp page in which this parameter will be used: either as a page variable, either as an action parameter (form or hyperlink).
`String`	`getLabelListName()` The name of the list holding the labels for this parameter.
`String`	`getMessageKey()` The default message key for this parameter.
`String`	`getMessageValue()` The default message value for this parameter.
`String`	`getMultiboxPropertyName()` The name of the array to be used for the multibox, this only makes sense when this parameter is actually a multibox.
`String`	`getNullValue()` The null value for the type of this parameter.
`String`	`getOnlineHelpKey()` The key to lookup the online help documentation.
`String`	`getOnlineHelpValue()` The online help documentation.
`int`	`getOptionCount()` In case this parameter represents an option set using radiobuttons, this attribute is a positive integer and zero otherwise.
`List`	`getOptionKeys()` If this parameter is a choice between radio buttons, then you may use this method to retrieve the message keys for the resource bundle.
`List`	`getOptionValues()` The values for the options.
`String`	`getResetName()` The name of the operation that resets this parameter to its original value.
`String`	`getResetValue()` The reset value for this parameter.
`StrutsAction`	`getStrutsAction()` Represents a Struts action.
`String`	`getStyleId()` TODO: Model Documentation for StrutsParameter.styleId
`List`	`getTableColumnActions(String columnName)` Those actions that are targetting this table's columns, only makes sense when this parameter represents a table page-variable.
`String`	`getTableColumnMessageKey(String columnName)` Returns the resource bundle key for this table's column, only returns a value when this parameter is a table.
`String`	`getTableColumnMessageValue(String columnName)` Returns the resource bundle value for this table's column, only returns a value when this parameter is a table.
`String`	`getTableDecoratorClassName()` The class name of the decorator to use for the table.
`String`	`getTableDecoratorFullPath()` The full path to the decorator class.
`String`	`getTableDecoratorFullyQualifiedName()` The complete table decorator classname.
`String`	`getTableDecoratorPackageName()` The package name of the decorator to use for the table.
`String`	`getTableExportTypes()` Tthe available types of export in a single String instance.
`List<StrutsAction>`	`getTableFormActions()` The actions used when submitting forms for this table.
`StrutsParameter`	`getTableGlobalActionParameter()` The column which is chosen to be submitted by the action targetting the entire table.
`Collection<StrutsAction>`	`getTableGlobalActions()` Returns those actions that allow table rows to be checked and submitted.
`List<StrutsAction>`	`getTableHyperlinkActions()` Those actions that are working on this table and are to be represented as hyperlinks.
`int`	`getTableMaxRows()` The maximum number of rows to be displayed in the table at the same time.
`String`	`getTimeFormat()` The time format for this parameter (if this parameter stores time).
`String`	`getTitleKey()` TODO: Model Documentation for StrutsParameter.titleKey
`String`	`getTitleValue()` TODO: Model Documentation for StrutsParameter.titleValue
`Collection`	`getValidatorArgs(String validatorType)` Returns the arguments for this parameter's validators.
`String`	`getValidatorMsgKey()` The message key for this parameter, equivalent to getMessageKey().
`Collection`	`getValidatorTypes()` A collection of all the validator types for this parameter.
`Collection`	`getValidatorVars()` The validator arguments.
`String`	`getValidWhen()` The validator's 'validwhen' value, this is useful when the validation of a parameter depends on the validation of others.
`String`	`getValueListName()` The name of the list holding the values for this parameter.
`String`	`getValueListResetValue()` The reset value for this parameter's value list.
`String`	`getWidgetType()` The widget type for this parameter, this value is the tagname for the Struts HTML taglib.
`boolean`	`isAllGlobalTableActionsHaveSameParameter()` This property is used in model validation.
`boolean`	`isCalendarRequired()` True if this parameter is a date and it requires a calendar popup.
`boolean`	`isCheckbox()` TODO: Model Documentation for StrutsParameter.checkbox
`boolean`	`isCombobox()` TODO: Model Documentation for StrutsParameter.combobox
`boolean`	`isDate()` True if the type of this parameter represents a date.
`boolean`	`isFile()` TODO: Model Documentation for StrutsParameter.file
`boolean`	`isHiddenField()` TODO: Model Documentation for StrutsParameter.hiddenField
`boolean`	`isHyperlink()` TODO: Model Documentation for StrutsParameter.hyperlink
`boolean`	`isMultibox()` TODO: Model Documentation for StrutsParameter.multibox
`boolean`	`isMultiple()` True if this parameter is either an array type or Collection type.
`boolean`	`isPassword()` True if this parameter represents a password field.
`boolean`	`isRadioButton()` TODO: Model Documentation for StrutsParameter.radioButton
`boolean`	`isReadOnly()` True if this parameter cannot be changed by the user, false otherwise.
`boolean`	`isResetRequired()` True if the value of this parameter must be reset between requests (Struts requires this for specific types), false otherwise.
`boolean`	`isSafeNamePresent()` True if this parameter has a name that can properly be handled by Jakarta commons (this lib is used by Struts but contains a bug)
`boolean`	`isSelectable()` Whether or not this parameter is selectable.
`boolean`	`isShouldReset()` Whether or not this parameter should be reset between requests.
`boolean`	`isSortableBy()` Indicates if a table can be sorted by this parameter.
`boolean`	`isStrictDateFormat()` True if the date format is to be strictly respected.
`boolean`	`isStrutsParameterMetaType()` Indicates the metafacade type (used for metafacade mappings).
`boolean`	`isTableDecoratorRequired()` TODO: Model Documentation for StrutsParameter.tableDecoratorRequired
`boolean`	`isTableExportable()` True if it is possible to export the table data to XML, CSV, PDF or Excel format.
`boolean`	`isTableFormActionSharingWidgets()` True if this table has form actions that share the column widgets.
`boolean`	`isTableHyperlinkColumn()` True if this parameter represents a table column into which an hyperlink must be rendered.
`boolean`	`isTableSortable()` True if it is possible to sort the columns of the table.
`boolean`	`isTextArea()` TODO: Model Documentation for StrutsParameter.textArea
`boolean`	`isTextField()` TODO: Model Documentation for StrutsParameter.textField
`boolean`	`isTime()` Indicates if this parameter's type represents a time.
`boolean`	`isValidationRequired()` True if this parameter requires some kind of validation.

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
  - isStrutsParameterMetaType
```
boolean isStrutsParameterMetaType()
```
    Indicates the metafacade type (used for metafacade mappings).
    
    Returns:
    boolean always true
  - 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.
    
    Returns:
    String
  - getCollectionImplementationType
```
String getCollectionImplementationType()
```
    If this parameter is a collection type, this property will represent the fully qualified name of a class suitable for implementation. If the type is neither Collection, List, nor Set the type itself is assumed.
    
    Returns:
    String
  - getDateFormat
```
String getDateFormat()
```
    If this parameter represents a date this method will return the format in which it must be represented. In case this format has not been specified by the any tagged value a default one will be taken.
    
    Returns:
    String
  - getDocumentationKey
```
String getDocumentationKey()
```
    The key to lookup the documentation for this parameter.
    
    Returns:
    String
  - getDocumentationValue
```
String getDocumentationValue()
```
    The documentation for this parameter, formatted to be inserted into a resource bundle.
    
    Returns:
    String
  - getFieldColumnCount
```
Integer getFieldColumnCount()
```
    The number of columns for this field, null if default browser value is desired.
    
    Returns:
    Integer
  - getFieldRowCount
```
Integer getFieldRowCount()
```
    The number of rows for this field, null if default browser value is desired.
    
    Returns:
    Integer
  - getFormFields
```
List<StrutsParameter> getFormFields()
```
    If this is a controller operation argument these form fields will represent the form fields for all actions deferring to the controller operation.
    
    Returns:
    List
  - getJsp
```
StrutsJsp getJsp()
```
    Represents the jsp page in which this parameter will be used: either as a page variable, either as an action parameter (form or hyperlink).
    
    Returns:
    StrutsJsp
  - getLabelListName
```
String getLabelListName()
```
    The name of the list holding the labels for this parameter. Only makes sense when the parameter is selectable.
    
    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
  - getMultiboxPropertyName
```
String getMultiboxPropertyName()
```
    The name of the array to be used for the multibox, this only makes sense when this parameter is actually a multibox.
    
    Returns:
    String
  - getNullValue
```
String getNullValue()
```
    The null value for the type of this parameter. For decimals this would be zero, for booleans this would be 'false', etc...
    
    Returns:
    String
  - getOnlineHelpKey
```
String getOnlineHelpKey()
```
    The key to lookup the online help documentation. This documentation is gathered from the documentation entered by the user, as well as analyzing the model.
    
    Returns:
    String
  - getOnlineHelpValue
```
String getOnlineHelpValue()
```
    The online help documentation. This documentation is gathered from the documentation entered by the user, as well as analyzing the model. The format is HTML without any style.
    
    Returns:
    String
  - getOptionCount
```
int getOptionCount()
```
    In case this parameter represents an option set using radiobuttons, this attribute is a positive integer and zero otherwise.
    
    Returns:
    int
  - getOptionKeys
```
List getOptionKeys()
```
    If this parameter is a choice between radio buttons, then you may use this method to retrieve the message keys for the resource bundle. The message keys hold the value to be displayed for the possible options.
    
    Returns:
    List
  - getOptionValues
```
List getOptionValues()
```
    The values for the options. Only makes sense when the widget type is radiobutton. The property value may directly be specified usiing the tagged value.
    
    Returns:
    List
  - getResetName
```
String getResetName()
```
    The name of the operation that resets this parameter to its original value.
    
    Returns:
    String
  - getResetValue
```
String getResetValue()
```
    The reset value for this parameter. The reset value is the non-null value to which this parameter is set by default between requests, you can use this method to be able to generate an application that will deploy and run with default data.
    
    Returns:
    String
  - getStrutsAction
```
StrutsAction getStrutsAction()
```
    Represents a Struts action. Such an action typically is associated with a form bean. This action model element extends a transition, but the actual logic contained by the action envelops all action states called, until either a final state or JSP page is reached.
    
    Returns:
    StrutsAction
  - getStyleId
```
String getStyleId()
```
    TODO: Model Documentation for StrutsParameter.styleId
    
    Returns:
    String
  - getTableColumnActions
```
List getTableColumnActions(String columnName)
```
    Those actions that are targetting this table's columns, only makes sense when this parameter represents a table page-variable.
    
    Parameters:
    columnName - String
    
    Returns:
    List
  - getTableColumnMessageKey
```
String getTableColumnMessageKey(String columnName)
```
    Returns the resource bundle key for this table's column, only returns a value when this parameter is a table.
    
    Parameters:
    columnName - String
    
    Returns:
    String
  - getTableColumnMessageValue
```
String getTableColumnMessageValue(String columnName)
```
    Returns the resource bundle value for this table's column, only returns a value when this parameter is a table.
    
    Parameters:
    columnName - String
    
    Returns:
    String
  - getTableDecoratorClassName
```
String getTableDecoratorClassName()
```
    The class name of the decorator to use for the table.
    
    Returns:
    String
  - getTableDecoratorFullPath
```
String getTableDecoratorFullPath()
```
    The full path to the decorator class.
    
    Returns:
    String
  - getTableDecoratorFullyQualifiedName
```
String getTableDecoratorFullyQualifiedName()
```
    The complete table decorator classname.
    
    Returns:
    String
  - getTableDecoratorPackageName
```
String getTableDecoratorPackageName()
```
    The package name of the decorator to use for the table.
    
    Returns:
    String
  - getTableExportTypes
```
String getTableExportTypes()
```
    Tthe available types of export in a single String instance.
    
    Returns:
    String
  - getTableFormActions
```
List<StrutsAction> getTableFormActions()
```
    The 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
  - getTableGlobalActionParameter
```
StrutsParameter getTableGlobalActionParameter()
```
    The column which is chosen to be submitted by the action targetting the entire table. Only makes sense when there are actually global table actions present for this table parameter.
    
    Returns:
    StrutsParameter
  - getTableGlobalActions
```
Collection<StrutsAction> getTableGlobalActions()
```
    Returns those actions that allow table rows to be checked and submitted. Only makes sense when this parameter represents a table page-variable.
    
    Returns:
    Collection
  - getTableHyperlinkActions
```
List<StrutsAction> getTableHyperlinkActions()
```
    Those actions that are working on this table and are to be represented as hyperlinks. It only makes sense to call this property on parameters that represent a table page-variable.
    
    Returns:
    List
  - getTableMaxRows
```
int getTableMaxRows()
```
    The maximum number of rows to be displayed in the table at the same time. This is also known as the page size. A value of zero or less will display all data in the same table (therefore also on the same page).
    
    Returns:
    int
  - getTimeFormat
```
String getTimeFormat()
```
    The time format for this parameter (if this parameter stores time).
    
    Returns:
    String
  - getTitleKey
```
String getTitleKey()
```
    TODO: Model Documentation for StrutsParameter.titleKey
    
    Returns:
    String
  - getTitleValue
```
String getTitleValue()
```
    TODO: Model Documentation for StrutsParameter.titleValue
    
    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 Struts validator plugin documentation for more information.
    
    Returns:
    String
  - getValidatorArgs
```
Collection getValidatorArgs(String validatorType)
```
    Returns the arguments for this parameter's validators.
    
    Parameters:
    validatorType - String
    
    Returns:
    Collection
  - getValidatorMsgKey
```
String getValidatorMsgKey()
```
    The message key for this parameter, equivalent to getMessageKey().
    
    Returns:
    String
  - getValidatorTypes
```
Collection getValidatorTypes()
```
    A collection of all the validator types for this parameter. Use this value in conjunction with the Struts validator plugin.
    
    Returns:
    Collection
  - getValidatorVars
```
Collection getValidatorVars()
```
    The validator arguments.
    
    Returns:
    Collection
  - getValueListName
```
String getValueListName()
```
    The name of the list holding the values for this parameter. Only makes sense when the parameter is selectable.
    
    Returns:
    String
  - getValueListResetValue
```
String getValueListResetValue()
```
    The reset value for this parameter's value list. Only makes sense if this parameter is selectable.
    
    Returns:
    String
  - getWidgetType
```
String getWidgetType()
```
    The widget type for this parameter, this value is the tagname for the Struts HTML taglib. This method is useful only when rendering forms.
    
    Returns:
    String
  - isAllGlobalTableActionsHaveSameParameter
```
boolean isAllGlobalTableActionsHaveSameParameter()
```
    This property is used in model validation. It denotes whether all actions targetting this table page-variable take the same parameter (same name and type). Only makes sense when this parameter is actually a table page-variable.
    
    Returns:
    boolean
  - isCalendarRequired
```
boolean isCalendarRequired()
```
    True if this parameter is a date and it requires a calendar popup.
    
    Returns:
    boolean
  - isCheckbox
```
boolean isCheckbox()
```
    TODO: Model Documentation for StrutsParameter.checkbox
    
    Returns:
    boolean
  - isCombobox
```
boolean isCombobox()
```
    TODO: Model Documentation for StrutsParameter.combobox
    
    Returns:
    boolean
  - isDate
```
boolean isDate()
```
    True if the type of this parameter represents a date. This is equivalent to parameter.type.isDateType().
    
    Returns:
    boolean
  - isFile
```
boolean isFile()
```
    TODO: Model Documentation for StrutsParameter.file
    
    Returns:
    boolean
  - isHiddenField
```
boolean isHiddenField()
```
    TODO: Model Documentation for StrutsParameter.hiddenField
    
    Returns:
    boolean
  - isHyperlink
```
boolean isHyperlink()
```
    TODO: Model Documentation for StrutsParameter.hyperlink
    
    Returns:
    boolean
  - isMultibox
```
boolean isMultibox()
```
    TODO: Model Documentation for StrutsParameter.multibox
    
    Returns:
    boolean
  - isMultiple
```
boolean isMultiple()
```
    True if this parameter is either an array type or Collection type.
    
    Returns:
    boolean
  - isPassword
```
boolean isPassword()
```
    True if this parameter represents a password field.
    
    Returns:
    boolean
  - isRadioButton
```
boolean isRadioButton()
```
    TODO: Model Documentation for StrutsParameter.radioButton
    
    Returns:
    boolean
  - isReadOnly
```
boolean isReadOnly()
```
    True if this parameter cannot be changed by the user, false otherwise.
    
    Returns:
    boolean
  - isResetRequired
```
boolean isResetRequired()
```
    True if the value of this parameter must be reset between requests (Struts requires this for specific types), false otherwise.
    
    Returns:
    boolean
  - isSafeNamePresent
```
boolean isSafeNamePresent()
```
    True if this parameter has a name that can properly be handled by Jakarta commons (this lib is used by Struts but contains a bug)
    
    Returns:
    boolean
  - isSelectable
```
boolean isSelectable()
```
    Whether or not this parameter is selectable. In case this would be true this parameter always has a backing list, a value list and a list containing the labels.
    
    Returns:
    boolean
  - isShouldReset
```
boolean isShouldReset()
```
    Whether or not this parameter should be reset between requests. This is different than resetRequired in that this is user specified.
    
    Returns:
    boolean
  - isSortableBy
```
boolean isSortableBy()
```
    Indicates if a table can be sorted by this parameter.
    
    Returns:
    boolean
  - isStrictDateFormat
```
boolean isStrictDateFormat()
```
    True if the date format is to be strictly respected. Otherwise the dateformatter used for the representation of this date is to be set to lenient.
    
    Returns:
    boolean
  - isTableDecoratorRequired
```
boolean isTableDecoratorRequired()
```
    TODO: Model Documentation for StrutsParameter.tableDecoratorRequired
    
    Returns:
    boolean
  - isTableExportable
```
boolean isTableExportable()
```
    True if it is possible to export the table data to XML, CSV, PDF or Excel format.
    
    Returns:
    boolean
  - isTableFormActionSharingWidgets
```
boolean isTableFormActionSharingWidgets()
```
    True if this table has form actions that share the column widgets. It is not allowed to have different actions use different widgets on the same column.
    
    Returns:
    boolean
  - isTableHyperlinkColumn
```
boolean isTableHyperlinkColumn()
```
    True if this parameter represents a table column into which an hyperlink must be rendered. This property only makes sense when it has been called on parameters representing an actual table column. Note that the getTableColumns() operation also returns String instances.
    
    Returns:
    boolean
  - isTableSortable
```
boolean isTableSortable()
```
    True if it is possible to sort the columns of the table.
    
    Returns:
    boolean
  - isTextArea
```
boolean isTextArea()
```
    TODO: Model Documentation for StrutsParameter.textArea
    
    Returns:
    boolean
  - isTextField
```
boolean isTextField()
```
    TODO: Model Documentation for StrutsParameter.textField
    
    Returns:
    boolean
  - isTime
```
boolean isTime()
```
    Indicates if this parameter's type represents a time.
    
    Returns:
    boolean
  - isValidationRequired
```
boolean isValidationRequired()
```
    True if this parameter requires some kind of validation. This means the collection of validator types is not empty.
    
    Returns:
    boolean

Interface StrutsParameter

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

isStrutsParameterMetaType

getBackingListName

getCollectionImplementationType

getDateFormat

getDocumentationKey

getDocumentationValue

getFieldColumnCount

getFieldRowCount

getFormFields

getJsp

getLabelListName

getMessageKey

getMessageValue

getMultiboxPropertyName

getNullValue

getOnlineHelpKey

getOnlineHelpValue

getOptionCount

getOptionKeys

getOptionValues

getResetName

getResetValue

getStrutsAction

getStyleId

getTableColumnActions

getTableColumnMessageKey

getTableColumnMessageValue

getTableDecoratorClassName

getTableDecoratorFullPath

getTableDecoratorFullyQualifiedName

getTableDecoratorPackageName

getTableExportTypes

getTableFormActions

getTableGlobalActionParameter

getTableGlobalActions

getTableHyperlinkActions

getTableMaxRows

getTimeFormat

getTitleKey

getTitleValue

getValidWhen

getValidatorArgs

getValidatorMsgKey

getValidatorTypes

getValidatorVars

getValueListName

getValueListResetValue

getWidgetType

isAllGlobalTableActionsHaveSameParameter

isCalendarRequired

isCheckbox

isCombobox

isDate

isFile

isHiddenField

isHyperlink

isMultibox

isMultiple

isPassword

isRadioButton

isReadOnly

isResetRequired

isSafeNamePresent

isSelectable

isShouldReset

isSortableBy

isStrictDateFormat

isTableDecoratorRequired

isTableExportable

isTableFormActionSharingWidgets

isTableHyperlinkColumn

isTableSortable

isTextArea

isTextField