com.hof.parameters

Interface Parameter

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

FileUploadParameter, ParameterImpl, PasswordParameter

public interface Parameter
extends java.io.Serializable

Method Summary

Methods

Modifier and Type	Method and Description
void	addPossibleValue(java.lang.Integer value, java.lang.String description)
void	addPossibleValue(java.lang.String value, java.lang.String description)
boolean	getAllowEnableDisableCallback() Returns true/false for allowing enable/disable callback on success/failure of a rule
java.util.Set<CssRule>	getCssRules() Get CSS Rules for this parameter
java.lang.Object	getDefaultValue() Get the defaultValue
java.lang.String	getDescription() Description of the parameter
java.util.List<ParameterDisplayRule>	getDisplayRules() When to display/hide this parameter
java.lang.String	getDynamicKey() Used if there is a value that can determine whether or not to load parameters, when a list with this key is returned all of the parameters in a section with a matching key will be removed and replaced with the list passed from the server.
java.lang.String	getEvent() Dynamic event that will be triggered by this parameter when it's state changes, this works in a similar fashion to valueDependencies except in reverse.
java.util.Map<java.lang.String,java.lang.Object>	getEventData() Any other data you want to be triggered with an event, this will be being used by the associated valueLoader after the event has been triggered
java.util.List<ValueDependent>	getEventParameters() A list of parameter values that should be added when this Parameters event is triggered, uses ValueDependent so that we can locate values that are in differing sections.
java.lang.String	getHelpText() If any help text is needed, define it here.
InputType	getInputType() Used for most basic input types, a user interface will be created relating to the input type
ListOptions	getListOptions() Options that will be used if this parameter is a list.
int	getMaxAllowed() max value
int	getMinAllowed() min value
java.lang.String	getName() Name of the parameter
java.util.Map<java.lang.String,ParameterValidation>	getObjectValidationRules() A set of a validation rules for objects of a parameter
java.lang.String	getParameterClassName()
java.util.Map<java.lang.String,ParameterValueDisplay>	getParameterValueDisplays()
java.util.List<com.hof.mi.models.report.CustomValue<?>>	getPossibleValues() Possible values that could be in the list, should be used for radio lists/checkbox lists and selects
java.lang.String	getProperty() Property to save the value too.
java.lang.String	getSpecialInputType() Used when a very specific input type is required that won't be very reusable for other things
ParameterValidation	getValidationRules() A set of validation rules for a parameter
java.util.List<ValueDependent>	getValueDependencies() Used if the Parameter we are setting up is dependent on something else For Example If option 1 is select a datasource and option 2 is select a view the views will be dependent on the datasource.
java.util.Map<java.lang.String,java.lang.Object>	getViewOptions() Options for views.
boolean	isList() Will this parameter generate a list of the defined parameter type E.g Do you want a list of textboxes that can be added to forever
boolean	isReadOnly() Should the user be able to edit this, or will it just be for display
void	setDynamicKey(java.lang.String dynamicKey) Method to set the dynamicKey

Method Detail

getInputType

InputType getInputType()

Used for most basic input types, a user interface will be created relating to the input type

getSpecialInputType

java.lang.String getSpecialInputType()

Used when a very specific input type is required that won't be very reusable for other things

getName

java.lang.String getName()

Name of the parameter

getDescription

java.lang.String getDescription()

Description of the parameter

getProperty

java.lang.String getProperty()

Property to save the value too.

getDefaultValue

java.lang.Object getDefaultValue()

Get the defaultValue

getHelpText

java.lang.String getHelpText()

If any help text is needed, define it here.

isReadOnly

boolean isReadOnly()

Should the user be able to edit this, or will it just be for display

getMaxAllowed

int getMaxAllowed()

max value

getMinAllowed

int getMinAllowed()

min value

getPossibleValues

java.util.List<com.hof.mi.models.report.CustomValue<?>> getPossibleValues()

Possible values that could be in the list, should be used for radio lists/checkbox lists and selects

addPossibleValue

void addPossibleValue(java.lang.String value,
                    java.lang.String description)

addPossibleValue

void addPossibleValue(java.lang.Integer value,
                    java.lang.String description)

getViewOptions

java.util.Map<java.lang.String,java.lang.Object> getViewOptions()

Options for views. Additional properties etc

getDisplayRules

java.util.List<ParameterDisplayRule> getDisplayRules()

When to display/hide this parameter

getParameterClassName

java.lang.String getParameterClassName()

getCssRules

java.util.Set<CssRule> getCssRules()

Get CSS Rules for this parameter

getParameterValueDisplays

java.util.Map<java.lang.String,ParameterValueDisplay> getParameterValueDisplays()

getAllowEnableDisableCallback

boolean getAllowEnableDisableCallback()

Returns true/false for allowing enable/disable callback on success/failure of a rule

isList

boolean isList()

Will this parameter generate a list of the defined parameter type E.g Do you want a list of textboxes that can be added to forever

getListOptions

ListOptions getListOptions()

Options that will be used if this parameter is a list. Will be ignored if isList returns false

getValidationRules

ParameterValidation getValidationRules()

A set of validation rules for a parameter

getObjectValidationRules

java.util.Map<java.lang.String,ParameterValidation> getObjectValidationRules()

A set of a validation rules for objects of a parameter

getValueDependencies

java.util.List<ValueDependent> getValueDependencies()

Used if the Parameter we are setting up is dependent on something else For Example If option 1 is select a datasource and option 2 is select a view the views will be dependent on the datasource. If this is set then once the the datasource changes the views should be updated

getDynamicKey

java.lang.String getDynamicKey()

Used if there is a value that can determine whether or not to load parameters, when a list with this key is returned all of the parameters in a section with a matching key will be removed and replaced with the list passed from the server. As an example, a set of parameters may be generated from an uploaded file with the dynamicKey "FILE", if a new file is uploaded a new set of "FILE" parameters will be returned and replace the existing ones

setDynamicKey

void setDynamicKey(java.lang.String dynamicKey)

Method to set the dynamicKey

Parameters:

dynamicKey -

getEvent

java.lang.String getEvent()

Dynamic event that will be triggered by this parameter when it's state changes, this works in a similar fashion to valueDependencies except in reverse. Can be used if there are many fields that are dependent on this "parent" field for values, or if dynamic parameters should be generated when this parameter changes.

getEventParameters

java.util.List<ValueDependent> getEventParameters()

A list of parameter values that should be added when this Parameters event is triggered, uses ValueDependent so that we can locate values that are in differing sections. Once the event is triggered, these values will be retrieved from the front-end model and passed to the back-end

getEventData

java.util.Map<java.lang.String,java.lang.Object> getEventData()

Any other data you want to be triggered with an event, this will be being used by the associated valueLoader after the event has been triggered