com.hof.parameters

Class ParameterImpl

java.lang.Object

com.hof.parameters.ParameterImpl

All Implemented Interfaces:

Parameter, java.io.Serializable

Direct Known Subclasses:

FileUploadParameter, PasswordParameter

public class ParameterImpl
extends java.lang.Object
implements Parameter

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ParameterImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	addDisplayRule(ParameterDisplayRule rule)
void	addEventData(java.lang.String key, java.lang.Object value)
void	addEventParameter(java.lang.String property, PropertyLocation location)
void	addEventParameter(java.lang.String property, java.lang.String panelKey, java.lang.String sectionKey)
void	addEventParameter(ValueDependent parameter)
void	addParameterValueDisplay(java.lang.String key, ParameterValueDisplay value)
void	addPossibleValue(java.lang.Integer value, java.lang.String description)
void	addPossibleValue(java.lang.Integer value, java.lang.String description, java.lang.String colour)
void	addPossibleValue(java.lang.String value, java.lang.String description)
void	addPossibleValue(java.lang.String value, java.lang.String description, java.lang.String colour)
void	addValueDependency(java.lang.String property)
void	addValueDependency(java.lang.String property, PropertyLocation location)
void	addValueDependency(ValueDependent vd)
void	addViewOption(java.lang.String property, java.lang.Object value)
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
int	getDataType()
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	setAllowEnableDisableCallback(boolean allowEnableDisableCallback)
void	setCssRules(java.util.Set<CssRule> cssRules) Set the CSS Rules for this parameter
void	setDataType(int dataType)
void	setDefaultValue(java.lang.Object defaultValue)
void	setDescription(java.lang.String description)
void	setDisplayRules(java.util.List<ParameterDisplayRule> displayRules)
void	setDynamicKey(java.lang.String dynamicKey) Method to set the dynamicKey
void	setEvent(java.lang.String event)
void	setEventData(java.util.Map<java.lang.String,java.lang.Object> eventData)
void	setEventParameters(java.util.List<ValueDependent> eventParameters)
void	setHelpText(java.lang.String helpText)
void	setInputType(InputType inputType)
void	setList(boolean list)
void	setListOptions(ListOptions listOptions)
void	setMaxAllowed(int maxAllowed)
void	setMinAllowed(int minAllowed)
void	setName(java.lang.String name)
void	setObjectValidationRules(java.util.Map<java.lang.String,ParameterValidation> objectValidationRules)
void	setParameterClassName(java.lang.String parameterClassName)
void	setPossibleValues(java.util.List<com.hof.mi.models.report.CustomValue<?>> possibleValues)
void	setProperty(java.lang.String property)
void	setReadOnly(boolean readOnly)
void	setSpecialInputType(java.lang.String specialInputType)
void	setValidationRules(ParameterValidation validationRules)
void	setValueDependencies(java.util.List<ValueDependent> valueDependencies)
void	setViewOptions(java.util.Map<java.lang.String,java.lang.Object> viewOptions)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ParameterImpl

public ParameterImpl()

Method Detail

setPossibleValues

public void setPossibleValues(java.util.List<com.hof.mi.models.report.CustomValue<?>> possibleValues)

getInputType

public InputType getInputType()

Description copied from interface: Parameter

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

Specified by:

getInputType in interface Parameter

getName

public java.lang.String getName()

Description copied from interface: Parameter

Name of the parameter

Specified by:

getName in interface Parameter

getDescription

public java.lang.String getDescription()

Description copied from interface: Parameter

Description of the parameter

Specified by:

getDescription in interface Parameter

getProperty

public java.lang.String getProperty()

Description copied from interface: Parameter

Property to save the value too.

Specified by:

getProperty in interface Parameter

getDefaultValue

public java.lang.Object getDefaultValue()

Description copied from interface: Parameter

Get the defaultValue

Specified by:

getDefaultValue in interface Parameter

getDataType

public int getDataType()

getHelpText

public java.lang.String getHelpText()

Description copied from interface: Parameter

If any help text is needed, define it here.

Specified by:

getHelpText in interface Parameter

isReadOnly

public boolean isReadOnly()

Description copied from interface: Parameter

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

Specified by:

isReadOnly in interface Parameter

getMinAllowed

public int getMinAllowed()

Description copied from interface: Parameter

min value

Specified by:

getMinAllowed in interface Parameter

getMaxAllowed

public int getMaxAllowed()

Description copied from interface: Parameter

max value

Specified by:

getMaxAllowed in interface Parameter

getViewOptions

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

Description copied from interface: Parameter

Options for views. Additional properties etc

Specified by:

getViewOptions in interface Parameter

getDisplayRules

public java.util.List<ParameterDisplayRule> getDisplayRules()

Description copied from interface: Parameter

When to display/hide this parameter

Specified by:

getDisplayRules in interface Parameter

setInputType

public void setInputType(InputType inputType)

setName

public void setName(java.lang.String name)

setDescription

public void setDescription(java.lang.String description)

setProperty

public void setProperty(java.lang.String property)

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

setDataType

public void setDataType(int dataType)

setHelpText

public void setHelpText(java.lang.String helpText)

setReadOnly

public void setReadOnly(boolean readOnly)

setMinAllowed

public void setMinAllowed(int minAllowed)

setMaxAllowed

public void setMaxAllowed(int maxAllowed)

addViewOption

public void addViewOption(java.lang.String property,
                 java.lang.Object value)

setViewOptions

public void setViewOptions(java.util.Map<java.lang.String,java.lang.Object> viewOptions)

setDisplayRules

public void setDisplayRules(java.util.List<ParameterDisplayRule> displayRules)

addDisplayRule

public void addDisplayRule(ParameterDisplayRule rule)

getPossibleValues

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

Description copied from interface: Parameter

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

Specified by:

getPossibleValues in interface Parameter

addPossibleValue

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

Specified by:

addPossibleValue in interface Parameter

addPossibleValue

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

Specified by:

addPossibleValue in interface Parameter

addPossibleValue

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

addPossibleValue

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

getSpecialInputType

public java.lang.String getSpecialInputType()

Description copied from interface: Parameter

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

Specified by:

getSpecialInputType in interface Parameter

setSpecialInputType

public void setSpecialInputType(java.lang.String specialInputType)

getParameterClassName

public java.lang.String getParameterClassName()

Specified by:

getParameterClassName in interface Parameter

setParameterClassName

public void setParameterClassName(java.lang.String parameterClassName)

getCssRules

public java.util.Set<CssRule> getCssRules()

Get CSS Rules for this parameter

Specified by:

getCssRules in interface Parameter

setCssRules

public void setCssRules(java.util.Set<CssRule> cssRules)

Set the CSS Rules for this parameter

addParameterValueDisplay

public void addParameterValueDisplay(java.lang.String key,
                            ParameterValueDisplay value)

getParameterValueDisplays

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

Specified by:

getParameterValueDisplays in interface Parameter

setAllowEnableDisableCallback

public void setAllowEnableDisableCallback(boolean allowEnableDisableCallback)

getAllowEnableDisableCallback

public boolean getAllowEnableDisableCallback()

Description copied from interface: Parameter

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

Specified by:

getAllowEnableDisableCallback in interface Parameter

setList

public void setList(boolean list)

isList

public boolean isList()

Description copied from interface: Parameter

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

Specified by:

isList in interface Parameter

getListOptions

public ListOptions getListOptions()

Description copied from interface: Parameter

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

Specified by:

getListOptions in interface Parameter

setListOptions

public void setListOptions(ListOptions listOptions)

getValidationRules

public ParameterValidation getValidationRules()

Description copied from interface: Parameter

A set of validation rules for a parameter

Specified by:

getValidationRules in interface Parameter

setValidationRules

public void setValidationRules(ParameterValidation validationRules)

getObjectValidationRules

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

Description copied from interface: Parameter

A set of a validation rules for objects of a parameter

Specified by:

getObjectValidationRules in interface Parameter

setObjectValidationRules

public void setObjectValidationRules(java.util.Map<java.lang.String,ParameterValidation> objectValidationRules)

getValueDependencies

public java.util.List<ValueDependent> getValueDependencies()

Description copied from interface: Parameter

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

Specified by:

getValueDependencies in interface Parameter

setValueDependencies

public void setValueDependencies(java.util.List<ValueDependent> valueDependencies)

addValueDependency

public void addValueDependency(java.lang.String property)

addValueDependency

public void addValueDependency(java.lang.String property,
                      PropertyLocation location)

addValueDependency

public void addValueDependency(ValueDependent vd)

getDynamicKey

public java.lang.String getDynamicKey()

Description copied from interface: Parameter

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

Specified by:

getDynamicKey in interface Parameter

setDynamicKey

public void setDynamicKey(java.lang.String dynamicKey)

Description copied from interface: Parameter

Method to set the dynamicKey

Specified by:

setDynamicKey in interface Parameter

getEvent

public java.lang.String getEvent()

Description copied from interface: Parameter

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.

Specified by:

getEvent in interface Parameter

setEvent

public void setEvent(java.lang.String event)

getEventParameters

public java.util.List<ValueDependent> getEventParameters()

Description copied from interface: Parameter

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

Specified by:

getEventParameters in interface Parameter

setEventParameters

public void setEventParameters(java.util.List<ValueDependent> eventParameters)

addEventParameter

public void addEventParameter(java.lang.String property,
                     java.lang.String panelKey,
                     java.lang.String sectionKey)

addEventParameter

public void addEventParameter(java.lang.String property,
                     PropertyLocation location)

addEventParameter

public void addEventParameter(ValueDependent parameter)

getEventData

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

Description copied from interface: Parameter

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

Specified by:

getEventData in interface Parameter

setEventData

public void setEventData(java.util.Map<java.lang.String,java.lang.Object> eventData)

addEventData

public void addEventData(java.lang.String key,
                java.lang.Object value)