Interface | osid.configuration.ParameterForm | ||
---|---|---|---|
Implements | osid.OsidRuleForm | ||
Description |
This is the form for creating and updating | ||
Method | getValueSyntaxMetadata | ||
Description |
Gets the metadata for the value syntax. | ||
Return | osid.Metadata | metadata for the value syntax | |
Compliance | mandatory | This method must be implemented. | |
Method | setValueSyntax | ||
Description |
Sets a value syntax. | ||
Parameters | osid.Syntax | syntax | the new value type |
Errors | INVALID_ARGUMENT | syntax is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | syntax is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearValueSyntax | ||
Description |
Clears the value syntax. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly() is
true | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueCoordinateTypeMetadata | ||
Description |
Gets the metadata for the coordinate type for coordinate values. | ||
Return | osid.Metadata | metadata for the coordinate type | |
Compliance | mandatory | This method must be implemented. | |
Method | setValueCoordinateType | ||
Description |
Sets a coordinate type. | ||
Parameters | osid.type.Type | coordinateType | the new coordinate type |
Errors | INVALID_ARGUMENT | coordinateType is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | coordinateType is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearValueCoordinateType | ||
Description |
Clears the coordinate type. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly() is
true | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueHeadingTypeMetadata | ||
Description |
Gets the metadata for the heading type for coordinate values. | ||
Return | osid.Metadata | metadata for the heading type | |
Compliance | mandatory | This method must be implemented. | |
Method | setValueHeadingType | ||
Description |
Sets a heading type. | ||
Parameters | osid.type.Type | headingType | the new heading type |
Errors | INVALID_ARGUMENT | headingType is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | headingType is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearValueHeadingType | ||
Description |
Clears the heading type. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly() is
true | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueObjectTypeMetadata | ||
Description |
Gets the metadata for the object value type for object values. | ||
Return | osid.Metadata | metadata for the object type | |
Compliance | mandatory | This method must be implemented. | |
Method | setValueObjectType | ||
Description |
Sets an object value type. | ||
Parameters | osid.type.Type | objectType | the new object type |
Errors | INVALID_ARGUMENT | objectType is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | objectType is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearValueObjectType | ||
Description |
Clears the object value type. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly() is
true | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueSpatialUnitRecordTypeMetadata | ||
Description |
Gets the metadata for the spatial unit record type for coordinate values. | ||
Return | osid.Metadata | metadata for the spatial unit record type | |
Compliance | mandatory | This method must be implemented. | |
Method | setValueSpatialUnitRecordType | ||
Description |
Sets a spatial unit record type. | ||
Parameters | osid.type.Type | spatialUnitRecordType | the new spatial unit record type |
Errors | INVALID_ARGUMENT | spatialUnitRecordType is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | spatialUnitRecordType is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearValueSpatialUnitRecordType | ||
Description |
Clears the spatial unit record type. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly() is
true | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueVersionSchemeMetadata | ||
Description |
Gets the metadata for the version type for object values. | ||
Return | osid.Metadata | metadata for the version type | |
Compliance | mandatory | This method must be implemented. | |
Method | setValueVersionScheme | ||
Description |
Sets a version type. | ||
Parameters | osid.type.Type | versionType | the new version type |
Errors | INVALID_ARGUMENT | versionType is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
NULL_ARGUMENT | versionType is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearValueVersionScheme | ||
Description |
Clears the version value type. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly() is
true | |
Compliance | mandatory | This method must be implemented. | |
Method | getValuesShuffledMetadata | ||
Description |
Gets the metadata for the shuffle type. | ||
Return | osid.Metadata | metadata for the shuffle flag | |
Compliance | mandatory | This method must be implemented. | |
Method | setValuesShuffled | ||
Description |
Sets the shuffle order. | ||
Parameters | boolean | shuffle | true to shuffle values by weight, false to
order values by index |
Errors | INVALID_ARGUMENT | shuffle is invalid | |
NO_ACCESS | Metadata.isReadOnly() is true | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearValuesShuffled | ||
Description |
Clears the shuffle flag. | ||
Errors | NO_ACCESS | Metadata.isRequired() or Metadata.isReadOnly() is
true | |
Compliance | mandatory | This method must be implemented. | |
Method | getParameterFormRecord | ||
Description |
Gets the | ||
Parameters | osid.type.Type | parameterRecordType | a parameter record type |
Return | osid.configuration.records.ParameterFormRecord | the parameter form record | |
Errors | NULL_ARGUMENT | parameterRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(parameterRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |