Documentation

BoundedVariableInterface extends VariableInterface
in

Models a variable that has known upper and lower bounds.

The data type maybe any scalar type.

Table of Contents

getDisplayValue()  : StringValueInterface
Extract a display value from a record If a locale is given the display value should be returned using the given locale. If the locale is not available a fallback MUST be used and an exeception MUST NOT be thrown
getLowerBound()  : string|float|int
getMeasure()  : Measure
Return the type of measure for this variable
getName()  : string
getRawConfigurationValue()  : mixed
getTitle()  : string
getUpperBound()  : string|float|int
getValue()  : ValueInterface|ValueSetInterface
Extracts the variable value from a record

Methods

getDisplayValue()

Extract a display value from a record If a locale is given the display value should be returned using the given locale. If the locale is not available a fallback MUST be used and an exeception MUST NOT be thrown

public getDisplayValue(RecordInterface $record[, null|string $locale = null ]) : StringValueInterface
Parameters
$record : RecordInterface
$locale : null|string = null
Return values
StringValueInterface —

getLowerBound()

public getLowerBound() : string|float|int
Return values
string|float|int —

the lowest allowable value (inclusive)

getName()

public getName() : string
Return values
string —

A unique identifier for the variable

getRawConfigurationValue()

public getRawConfigurationValue(string $key) : mixed
Parameters
$key : string
Return values
mixed —

getTitle()

public getTitle([null|string $locale = null ]) : string
Parameters
$locale : null|string = null
Return values
string —

The title text in the default language If a locale is given the display value should be returned using the given locale. If the locale is not available a fallback MUST be used and an exeception MUST NOT be thrown

getUpperBound()

public getUpperBound() : string|float|int
Return values
string|float|int —

the highest allowable value (exclusive)

Search results