public interface Parameter extends OsidRule
A parameter is used to map configuration values to an identifier and
syntax. The type of the value must be used across all values of the same
parameter. The values associated with a parameter should be queried
through the ValueLookupSession.
Modifier and Type | Method and Description |
---|---|
boolean |
areValuesShuffled()
Tests if if the values assigned to this parameter will be shuffled or
values are sorted by index.
|
ParameterRecord |
getParameterRecord(Type parameterRecordType)
Gets the parameter record corresponding to the given
Parameter
record Type. |
Type |
getValueCoordinateType()
Gets the type of the value if the syntax is a coordinate.
|
Type |
getValueHeadingType()
Gets the type of the value if the syntax is a heading.
|
Type |
getValueObjectType()
Gets the type of the value if the syntax is an object.
|
Type |
getValueSpatialUnitRecordType()
Gets the type of the value if the syntax is a spatial unit.
|
Syntax |
getValueSyntax()
Gets the syntax for the values of this parameter.
|
Type |
getValueVersionScheme()
Gets the type of the value if the syntax is a version.
|
boolean |
implementsValueCoordinateType(Type coordinateType)
Tests if the coordinate supports the given coordinate
Type. |
boolean |
implementsValueHeadingType(Type headingType)
Tests if the heading supports the given heading
Type. |
boolean |
implementsValueObjectType(Type valueType)
Tests if the object supports the given
Type. |
boolean |
implementsValueSpatialUnitRecordType(Type spatialUnitRecordType)
Tests if the spatial unit supports the given record
Type. |
boolean |
implementsValueVersionScheme(Type versionType)
Tests if the version supports the given version
Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
Syntax getValueSyntax()
mandatory
- This method must be implemented. Type getValueCoordinateType()
IllegalStateException
- getValueSyntax() !=
COORDINATE
mandatory
- This method must be implemented. boolean implementsValueCoordinateType(Type coordinateType)
Type.
coordinateType
- a coordinate type true
if the coordinate values associated with
this parameter implement the given coordinate Type,
false
otherwiseIllegalStateException
- getValueSyntax() !=
COORDINATE
NullArgumentException
- coordinateType
is null
mandatory
- This method must be implemented. Type getValueHeadingType()
IllegalStateException
- getValueSyntax() !=
HEADING
mandatory
- This method must be implemented. boolean implementsValueHeadingType(Type headingType)
Type.
headingType
- a heading type true
if the heading values associated with this
parameter implement the given heading Type,
false
otherwiseIllegalStateException
- getValueSyntax() !=
HEADING
NullArgumentException
- headingType
is
null
mandatory
- This method must be implemented. Type getValueObjectType()
IllegalStateException
- getValueSyntax() !=
OBJECT
mandatory
- This method must be implemented. boolean implementsValueObjectType(Type valueType)
Type.
This
method should be checked before retrieving the object value.valueType
- a type true
if the obect values associated with this
parameter implement the given Type,
false
otherwiseIllegalStateException
- getValueSyntax() !=
OBJECT
NullArgumentException
- valueType
is
null
mandatory
- This method must be implemented. Type getValueSpatialUnitRecordType()
IllegalStateException
- getValueSyntax() !=
SPATIALUNIT
mandatory
- This method must be implemented. boolean implementsValueSpatialUnitRecordType(Type spatialUnitRecordType)
Type.
spatialUnitRecordType
- a spatial unit record type true
if the spatial unit values associated with
this parameter implement the given record Type,
false
otherwiseIllegalStateException
- getValueSyntax() !=
SPATIALUNIT
NullArgumentException
- spatialUnitRecordTYpe
is null
mandatory
- This method must be implemented. Type getValueVersionScheme()
IllegalStateException
- getValueSyntax() !=
VERSION
mandatory
- This method must be implemented. boolean implementsValueVersionScheme(Type versionType)
Type.
versionType
- a version type true
if the version values associated with this
parameter implement the given version Type,
false
otherwiseIllegalStateException
- getValueSyntax() !=
VERSION
NullArgumentException
- versionType
is
null
mandatory
- This method must be implemented. boolean areValuesShuffled()
true
if the values are shuffled, false
otherwisemandatory
- This method must be implemented. ParameterRecord getParameterRecord(Type parameterRecordType) throws OperationFailedException
Parameter
record Type.
This method is used to retrieve an
object implementing the requested record. The
parameterRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(parameterRecordType)
is true
.parameterRecordType
- the type of parameter record to retrieveNullArgumentException
- parameterRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(parameterRecordType)
is false
mandatory
- This method must be implemented.