OSID Logo
OSID Specifications
configuration package
Version 3.0.0
Release Candidate Preview
Interfaceosid.configuration.ParameterForm
Implementsosid.OsidRuleForm
Description

This is the form for creating and updating Parameters. Various data elements may be set here for use in the create and update methods in the ParameterAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetValueSyntaxMetadata
Description

Gets the metadata for the value syntax.

Returnosid.Metadatametadata for the value syntax
CompliancemandatoryThis method must be implemented.
MethodsetValueSyntax
Description

Sets a value syntax.

Parametersosid.Syntaxsyntaxthe new value type
ErrorsINVALID_ARGUMENT syntax is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT syntax is null
CompliancemandatoryThis method must be implemented.
MethodclearValueSyntax
Description

Clears the value syntax.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetValueCoordinateTypeMetadata
Description

Gets the metadata for the coordinate type for coordinate values.

Returnosid.Metadatametadata for the coordinate type
CompliancemandatoryThis method must be implemented.
MethodsetValueCoordinateType
Description

Sets a coordinate type.

Parametersosid.type.TypecoordinateTypethe new coordinate type
ErrorsINVALID_ARGUMENT coordinateType is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT coordinateType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueCoordinateType
Description

Clears the coordinate type.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetValueHeadingTypeMetadata
Description

Gets the metadata for the heading type for coordinate values.

Returnosid.Metadatametadata for the heading type
CompliancemandatoryThis method must be implemented.
MethodsetValueHeadingType
Description

Sets a heading type.

Parametersosid.type.TypeheadingTypethe new heading type
ErrorsINVALID_ARGUMENT headingType is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT headingType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueHeadingType
Description

Clears the heading type.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetValueObjectTypeMetadata
Description

Gets the metadata for the object value type for object values.

Returnosid.Metadatametadata for the object type
CompliancemandatoryThis method must be implemented.
MethodsetValueObjectType
Description

Sets an object value type.

Parametersosid.type.TypeobjectTypethe new object type
ErrorsINVALID_ARGUMENT objectType is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT objectType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueObjectType
Description

Clears the object value type.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetValueSpatialUnitRecordTypeMetadata
Description

Gets the metadata for the spatial unit record type for coordinate values.

Returnosid.Metadatametadata for the spatial unit record type
CompliancemandatoryThis method must be implemented.
MethodsetValueSpatialUnitRecordType
Description

Sets a spatial unit record type.

Parametersosid.type.TypespatialUnitRecordTypethe new spatial unit record type
ErrorsINVALID_ARGUMENT spatialUnitRecordType is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT spatialUnitRecordType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueSpatialUnitRecordType
Description

Clears the spatial unit record type.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetValueVersionSchemeMetadata
Description

Gets the metadata for the version type for object values.

Returnosid.Metadatametadata for the version type
CompliancemandatoryThis method must be implemented.
MethodsetValueVersionScheme
Description

Sets a version type.

Parametersosid.type.TypeversionTypethe new version type
ErrorsINVALID_ARGUMENT versionType is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT versionType is null
CompliancemandatoryThis method must be implemented.
MethodclearValueVersionScheme
Description

Clears the version value type.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetValuesShuffledMetadata
Description

Gets the metadata for the shuffle type.

Returnosid.Metadatametadata for the shuffle flag
CompliancemandatoryThis method must be implemented.
MethodsetValuesShuffled
Description

Sets the shuffle order.

Parametersbooleanshuffle true to shuffle values by weight, false to order values by index
ErrorsINVALID_ARGUMENT shuffle is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearValuesShuffled
Description

Clears the shuffle flag.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetParameterFormRecord
Description

Gets the ParameterFormRecord corresponding to the given parameter record Type.

Parametersosid.type.TypeparameterRecordTypea parameter record type
Returnosid.configuration.records.ParameterFormRecordthe parameter form record
ErrorsNULL_ARGUMENT parameterRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(parameterRecordType) is false
CompliancemandatoryThis method must be implemented.