Interface | osid.configuration.Value | ||
---|---|---|---|
Implements | osid.OsidObject | ||
osid.Operable | |||
osid.Subjugateable | |||
Description |
This interface specifies the value of a configuration parameter. | ||
Method | getParameterId | ||
Description |
Gets the parameter | ||
Return | osid.id.Id | the parameter Id | |
Compliance | mandatory | This method must be implemented. | |
Method | getParameter | ||
Description |
Gets the parameter of this value. | ||
Return | osid.configuration.Parameter | the parameter | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | getPriority | ||
Description |
Gets the priority of this value. If the values for this parameter are not shuffled, the priority indicates a static ordering of the values from lowest to highest. If the values for this parameter are shuffled, the priority effects the weight with greater numbers having greater weights. | ||
Return | cardinal | the index of this value | |
Compliance | mandatory | This method must be implemented. | |
Method | getBooleanValue | ||
Description |
Gets the value if it is a boolean. | ||
Return | boolean | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != BOOLEAN | |
Compliance | mandatory | This method must be implemented. | |
Method | getBytesValue | ||
Description |
Gets the value if it is a byte. | ||
Return | byte[] | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != BYTE | |
Compliance | mandatory | This method must be implemented. | |
Method | getCardinalValue | ||
Description |
Gets the value if it is a cardinal. | ||
Return | cardinal | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != CARDINAL | |
Compliance | mandatory | This method must be implemented. | |
Method | getCoordinateValue | ||
Description |
Gets the value if it is a coordinate. | ||
Return | osid.mapping.Coordinate | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != COORDINATE | |
Compliance | mandatory | This method must be implemented. | |
Method | getCurrencyValue | ||
Description |
Gets the value if it is a currency. | ||
Return | osid.financials.Currency | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != CURRENCY | |
Compliance | mandatory | This method must be implemented. | |
Method | getDateTimeValue | ||
Description |
Gets the value if it is a | ||
Return | osid.calendaring.DateTime | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != DATETIME | |
Compliance | mandatory | This method must be implemented. | |
Method | getDecimalValue | ||
Description |
Gets the value if it is a decimal. | ||
Return | decimal | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != DECIMAL | |
Compliance | mandatory | This method must be implemented. | |
Method | getDistanceValue | ||
Description |
Gets the value if it is a | ||
Return | osid.mapping.Distance | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != DISTANCE | |
Compliance | mandatory | This method must be implemented. | |
Method | getDurationValue | ||
Description |
Gets the value if it is a | ||
Return | osid.calendaring.Duration | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != DURATION | |
Compliance | mandatory | This method must be implemented. | |
Method | getHeadingValue | ||
Description |
Gets the value if it is a | ||
Return | osid.mapping.Heading | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != HEADING | |
Compliance | mandatory | This method must be implemented. | |
Method | getIdValue | ||
Description |
Gets the value if it is an | ||
Return | osid.id.Id | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != ID | |
Compliance | mandatory | This method must be implemented. | |
Method | getIntegerValue | ||
Description |
Gets the value if it is an integer. | ||
Return | integer | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != INTEGER | |
Compliance | mandatory | This method must be implemented. | |
Method | getObjectValue | ||
Description |
Gets the value if it is an object. | ||
Return | object | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != OBJECT | |
Compliance | mandatory | This method must be implemented. | |
Method | getSpatialUnitValue | ||
Description |
Gets the value if it is a spatial unit. | ||
Return | osid.mapping.SpatialUnit | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != SPATIALUNIT | |
Compliance | mandatory | This method must be implemented. | |
Method | getSpeedValue | ||
Description |
Gets the value if it is a speed. | ||
Return | osid.mapping.Speed | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != SPEED | |
Compliance | mandatory | This method must be implemented. | |
Method | getStringValue | ||
Description |
Gets the value if it is a string. | ||
Return | string | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != STRING | |
Compliance | mandatory | This method must be implemented. | |
Method | getTimeValue | ||
Description |
Gets the value if it is a time. | ||
Return | osid.calendaring.Time | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != TIME | |
Compliance | mandatory | This method must be implemented. | |
Method | getTypeValue | ||
Description |
Gets the value if it is a | ||
Return | osid.type.Type | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != TYPE | |
Compliance | mandatory | This method must be implemented. | |
Method | getVersionValue | ||
Description |
Gets the value if it is a version. | ||
Return | osid.installation.Version | the value | |
Errors | ILLEGAL_STATE | Parameter.getSyntax() != VERSION | |
Compliance | mandatory | This method must be implemented. | |
Method | getValueRecord | ||
Description |
Gets the value record corresponding to the given | ||
Parameters | osid.type.Type | valueRecordType | the type of value record to retrieve |
Return | osid.configuration.records.ValueRecord | the value record | |
Errors | NULL_ARGUMENT | valueRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(valueRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |