org.openmrs.report

Class Parameter

java.lang.Object

org.openmrs.report.Parameter

Deprecated.

see reportingcompatibility module

@Deprecated
public class Parameter
extends java.lang.Object

Parameters are used in a ReportSchema, LogicCriteria, and CohortFromStrategy, etc

If an object is parameterizable, it is willing to accept a parameter like this. Examples of a parameter would be "What start date do you want to use?" The value of the parameter would be plugged in when the object is evaluated.

See Also:

LogicCriteria, Parameterizable

Constructor Summary

Constructors

Constructor and Description
Parameter() Deprecated. Default constructor
Parameter(java.lang.String name, java.lang.String label, java.lang.Class<?> clazz, java.lang.Object defaultValue) Deprecated. Initialize this Parameter with the given values

Method Summary

Modifier and Type	Method and Description
java.lang.Class<?>	getClazz() Deprecated.
java.lang.Object	getDefaultValue() Deprecated.
java.lang.String	getLabel() Deprecated.
java.lang.String	getName() Deprecated.
boolean	isRequired() Deprecated. Whether or not this parameter "must" be filled in by a value
void	setClazz(java.lang.Class<?> clazz) Deprecated.
void	setDefaultValue(java.lang.Object defaultValue) Deprecated.
void	setLabel(java.lang.String label) Deprecated.
void	setName(java.lang.String name) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

Parameter

public Parameter()

Deprecated.

Default constructor

Parameter

public Parameter(java.lang.String name,
                 java.lang.String label,
                 java.lang.Class<?> clazz,
                 java.lang.Object defaultValue)

Deprecated.

Initialize this Parameter with the given values

Parameters:

name - The defined descriptive name

label - The label to display to the user if value is needed

clazz - The data type of this parameter

defaultValue - The value to fill in if nothing provided by the user

Method Detail

isRequired

public boolean isRequired()

Deprecated.

Whether or not this parameter "must" be filled in by a value

Returns:

true/false whether the user has to give their input

getClazz

public java.lang.Class<?> getClazz()

Deprecated.

setClazz

public void setClazz(java.lang.Class<?> clazz)

Deprecated.

getDefaultValue

public java.lang.Object getDefaultValue()

Deprecated.

setDefaultValue

public void setDefaultValue(java.lang.Object defaultValue)

Deprecated.

getLabel

public java.lang.String getLabel()

Deprecated.

setLabel

public void setLabel(java.lang.String label)

Deprecated.

getName

public java.lang.String getName()

Deprecated.

setName

public void setName(java.lang.String name)

Deprecated.