Metadata¶

class dlkit.osid.metadata.Metadata¶

The Metadata interface defines a set of methods describing a the syntax and rules for creating and updating a data element inside an OsidForm.

This interface provides a means to retrieve special restrictions placed upon data elements such as sizes and ranges that may vary from provider to provider or from object to object.

element_id¶

Gets a unique Id for the data element.

Returns:	an `Id`
Return type:	`osid.id.Id`

element_label¶

Gets a display label for the data element.

Returns:	a display label
Return type:	`osid.locale.DisplayText`

instructions¶

Gets instructions for updating this element value.

This is a human readable description of the data element or property that may include special instructions or caveats to the end-user above and beyond what this interface provides.

Returns:	instructions
Return type:	`osid.locale.DisplayText`

syntax¶

Gets the syntax of this data.

Returns:	an enumeration indicating thetype of value
Return type:	`osid.Syntax`

is_array()¶

Tests if this data element is an array.

Returns:	`true` if this data is an array, `false` if a single element
Return type:	`boolean`

is_required()¶

Tests if this data element is required for creating new objects.

Returns:	`true` if this element value is required, `false` otherwise
Return type:	`boolean`

is_read_only()¶

Tests if this data can be updated.

This may indicate the result of a pre-authorization but is not a guarantee that an authorization failure will not occur when the create or update transaction is issued.

Returns:	`true` if this data is not updatable, `false` otherwise
Return type:	`boolean`

is_linked()¶

Tests if this data element is linked to other data in the object.

Updating linked data elements should refresh all metadata and revalidate object elements.

Returns:	true if this element is linked, false if updates have no side effect
Return type:	`boolean`

is_value_known()¶

Tests if an existing value is known for this data element.

If it is known that a value does not exist, then this method returns true.

Returns:	`true` if the element value is known, `false` if the element value is not known
Return type:	`boolean`

has_value()¶

Tests if this data element has a set non-default value.

Returns:	`true` if this element value has been set, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – `is_value_known()` is `false`

units¶

Gets the units of this data for display purposes (‘lbs’, ‘gills’, ‘furlongs’).

Returns:	the display units of this data or an empty string if not applicable
Return type:	`osid.locale.DisplayText`

minimum_elements¶

In the case where an array or list of elements is specified in an OsidForm, this specifies the minimum number of elements that must be included.

Returns:	the minimum elements or `1` if `is_array()` is `false`
Return type:	`cardinal`

maximum_elements¶

In the case where an array or list of elements is specified in an OsidForm, this specifies the maximum number of elements that can be specified.

Returns:	the maximum elements or `1` if `is_array()` is `false`
Return type:	`cardinal`

minimum_cardinal¶

Gets the minimum cardinal value.

Returns:	the minimum cardinal
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `CARDINAL`

maximum_cardinal¶

Gets the maximum cardinal value.

Returns:	the maximum cardinal
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `CARDINAL`

cardinal_set¶

Gets the set of acceptable cardinal values.

Returns:	a set of cardinals or an empty array if not restricted
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `CARDINAL`

default_cardinal_values¶

Gets the default cardinal values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default cardinal values
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `CARDINAL` or `is_required()` is `true`

existing_cardinal_values¶

Gets the existing cardinal values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing cardinal values
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `CARDINAL` or `is_value_known()` is `false`

coordinate_types¶

Gets the set of acceptable coordinate types.

Returns:	the set of coordinate types
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `COORDINATE or SPATIALUNIT`

supports_coordinate_type(coordinate_type)¶

Tests if the given coordinate type is supported.

Parameters:	coordinate_type (`osid.type.Type`) – a coordinate Type
Returns:	`true` if the type is supported, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – syntax is not a `COORDINATE`
Raise:	`NullArgument` – `coordinate_type` is `null`

get_axes_for_coordinate_type(coordinate_type)¶

Gets the number of axes for a given supported coordinate type.

Parameters:	coordinate_type (`osid.type.Type`) – a coordinate Type
Returns:	the number of axes
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `COORDINATE`
Raise:	`NullArgument` – `coordinate_type` is `null`
Raise:	`Unsupported` – `supports_coordinate_type(coordinate_type)` is `false`

get_minimum_coordinate_values(coordinate_type)¶

Gets the minimum coordinate values given supported coordinate type.

Parameters:	coordinate_type (`osid.type.Type`) – a coordinate Type
Returns:	the minimum coordinate values
Return type:	`decimal`
Raise:	`IllegalState` – syntax is not a `COORDINATE`
Raise:	`NullArgument` – `coordinate_type` is `null`
Raise:	`Unsupported` – `supports_coordinate_type(coordinate_type)` is `false`

get_maximum_coordinate_values(coordinate_type)¶

Gets the maximum coordinate values given supported coordinate type.

Parameters:	coordinate_type (`osid.type.Type`) – a coordinate Type
Returns:	the maximum coordinate values
Return type:	`decimal`
Raise:	`IllegalState` – syntax is not a `COORDINATE`
Raise:	`NullArgument` – `coordinate_type` is `null`
Raise:	`Unsupported` – `supports_coordinate_type(coordinate_type)` is `false`

coordinate_set¶

Gets the set of acceptable coordinate values.

Returns:	a set of coordinates or an empty array if not restricted
Return type:	`osid.mapping.Coordinate`
Raise:	`IllegalState` – syntax is not a `COORDINATE`

default_coordinate_values¶

Gets the default coordinate values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default coordinate values
Return type:	`osid.mapping.Coordinate`
Raise:	`IllegalState` – syntax is not a `COORDINATE` or `is_required()` is `true`

existing_coordinate_values¶

Gets the existing coordinate values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing coordinate values
Return type:	`osid.mapping.Coordinate`
Raise:	`IllegalState` – syntax is not a `COORDINATE` or `is_value_known()` is `false`

currency_types¶

Gets the set of acceptable currency types.

Returns:	the set of currency types
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `CURRENCY`

supports_currency_type(currency_type)¶

Tests if the given currency type is supported.

Parameters:	currency_type (`osid.type.Type`) – a currency Type
Returns:	`true` if the type is supported, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – syntax is not a `CURRENCY`
Raise:	`NullArgument` – `currency_type` is `null`

minimum_currency¶

Gets the minimum currency value.

Returns:	the minimum currency
Return type:	`osid.financials.Currency`
Raise:	`IllegalState` – syntax is not a `CURRENCY`

maximum_currency¶

Gets the maximum currency value.

Returns:	the maximum currency
Return type:	`osid.financials.Currency`
Raise:	`IllegalState` – syntax is not a `CURRENCY`

currency_set¶

Gets the set of acceptable currency values.

Returns:	a set of currencies or an empty array if not restricted
Return type:	`osid.financials.Currency`
Raise:	`IllegalState` – syntax is not a `CURRENCY`

default_currency_values¶

Gets the default currency values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default currency values
Return type:	`osid.financials.Currency`
Raise:	`IllegalState` – syntax is not a `CURRENCY` or `is_required()` is `true`

existing_currency_values¶

Gets the existing currency values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing currency values
Return type:	`osid.financials.Currency`
Raise:	`IllegalState` – syntax is not a `CURRENCY` or `is_value_known()` is `false`

date_time_resolution¶

Gets the smallest resolution of the date time value.

Returns:	the resolution
Return type:	`osid.calendaring.DateTimeResolution`
Raise:	`IllegalState` – syntax is not a `DATETIME, DURATION` , or `TIME`

calendar_types¶

Gets the set of acceptable calendar types.

Returns:	the set of calendar types
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `DATETIME` or `DURATION`

supports_calendar_type(calendar_type)¶

Tests if the given calendar type is supported.

Parameters:	calendar_type (`osid.type.Type`) – a calendar Type
Returns:	`true` if the type is supported, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – syntax is not a `DATETIME` or `DURATION`
Raise:	`NullArgument` – `calendar_type` is `null`

time_types¶

Gets the set of acceptable time types.

Returns:	a set of time types or an empty array if not restricted
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `DATETIME, DURATION,` or `TIME`

supports_time_type(time_type)¶

Tests if the given time type is supported.

Parameters:	time_type (`osid.type.Type`) – a time Type
Returns:	`true` if the type is supported, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – syntax is not a `DATETIME, DURATION,` or `TIME`
Raise:	`NullArgument` – `time_type` is `null`

minimum_date_time¶

Gets the minimum date time value.

Returns:	the minimum value
Return type:	`osid.calendaring.DateTime`
Raise:	`IllegalState` – syntax is not a `DATETIME`

maximum_date_time¶

Gets the maximum date time value.

Returns:	the maximum value
Return type:	`osid.calendaring.DateTime`
Raise:	`IllegalState` – syntax is not a `DATETIME`

date_time_set¶

Gets the set of acceptable date time values.

Returns:	a set of values or an empty array if not restricted
Return type:	`osid.calendaring.DateTime`
Raise:	`IllegalState` – syntax is not a `DATETIME`

default_date_time_values¶

Gets the default date time values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default date time values
Return type:	`osid.calendaring.DateTime`
Raise:	`IllegalState` – syntax is not a `DATETIME` or `is_required()` is `true`

existing_date_time_values¶

Gets the existing date time values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing date time values
Return type:	`osid.calendaring.DateTime`
Raise:	`IllegalState` – syntax is not a `DATETIME` or `is_value_known()` is `false`

decimal_scale¶

Gets the number of digits to the right of the decimal point.

Returns:	the scale
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `DECIMAL`

minimum_decimal¶

Gets the minimum decimal value.

Returns:	the minimum decimal
Return type:	`decimal`
Raise:	`IllegalState` – syntax is not a `DECIMAL`

maximum_decimal¶

Gets the maximum decimal value.

Returns:	the maximum decimal
Return type:	`decimal`
Raise:	`IllegalState` – syntax is not a `DECIMAL`

decimal_set¶

Gets the set of acceptable decimal values.

Returns:	a set of decimals or an empty array if not restricted
Return type:	`decimal`
Raise:	`IllegalState` – syntax is not a `DECIMAL`

default_decimal_values¶

Gets the default decimal values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default decimal values
Return type:	`decimal`
Raise:	`IllegalState` – syntax is not a `DECIMAL` or `is_required()` is `true`

existing_decimal_values¶

Gets the existing decimal values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing decimal values
Return type:	`decimal`
Raise:	`IllegalState` – syntax is not a `DECIMAL` or `is_value_known()` is `false`

distance_resolution¶

Gets the smallest resolution of the distance value.

Returns:	the resolution
Return type:	`osid.mapping.DistanceResolution`
Raise:	`IllegalState` – syntax is not a `DISTANCE`

minimum_distance¶

Gets the minimum distance value.

Returns:	the minimum value
Return type:	`osid.mapping.Distance`
Raise:	`IllegalState` – syntax is not a `DISTANCE`

maximum_distance¶

Gets the maximum distance value.

Returns:	the maximum value
Return type:	`osid.mapping.Distance`
Raise:	`IllegalState` – syntax is not a `DISTANCE`

distance_set¶

Gets the set of acceptable distance values.

Returns:	a set of values or an empty array if not restricted
Return type:	`osid.mapping.Distance`
Raise:	`IllegalState` – syntax is not a `DISTANCE`

default_distance_values¶

Gets the default distance values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default distance values
Return type:	`osid.mapping.Distance`
Raise:	`IllegalState` – syntax is not a `DISTANCE` or `is_required()` is `true`

existing_distance_values¶

Gets the existing distance values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing distance values
Return type:	`osid.mapping.Distance`
Raise:	`IllegalState` – syntax is not a `DISTANCE` or `is_value_known()` is `false`

minimum_duration¶

Gets the minimum duration.

Returns:	the minimum duration
Return type:	`osid.calendaring.Duration`
Raise:	`IllegalState` – syntax is not a `DURATION`

maximum_duration¶

Gets the maximum duration.

Returns:	the maximum duration
Return type:	`osid.calendaring.Duration`
Raise:	`IllegalState` – syntax is not a `DURATION`

duration_set¶

Gets the set of acceptable duration values.

Returns:	a set of durations or an empty array if not restricted
Return type:	`osid.calendaring.Duration`
Raise:	`IllegalState` – syntax is not a `DURATION`

default_duration_values¶

Gets the default duration values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most at most a single value.

Returns:	the default duration values
Return type:	`osid.calendaring.Duration`
Raise:	`IllegalState` – syntax is not a DURATION or `is_required()` is `true`

existing_duration_values¶

Gets the existing duration values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing duration values
Return type:	`osid.calendaring.Duration`
Raise:	`IllegalState` – syntax is not a `DURATION` or `is_value_known()` is `false`

heading_types¶

Gets the set of acceptable heading types.

Returns:	a set of heading types or an empty array if not restricted
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `HEADING`

supports_heading_type(heading_type)¶

Tests if the given heading type is supported.

Parameters:	heading_type (`osid.type.Type`) – a heading Type
Returns:	`true` if the type is supported, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – syntax is not a `HEADING`
Raise:	`NullArgument` – `heading_type` is `null`

get_axes_for_heading_type(heading_type)¶

Gets the number of axes for a given supported heading type.

Parameters:	heading_type (`osid.type.Type`) – a heading Type
Returns:	the number of axes
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `HEADING`
Raise:	`NullArgument` – `heading_type` is `null`
Raise:	`Unsupported` – `supports_heading_type(heading_type)` is `false`

get_minimum_heading_values(heading_type)¶

Gets the minimum heading values given supported heading type.

Parameters:	heading_type (`osid.type.Type`) – a heading Type
Returns:	the minimum heading values
Return type:	`decimal`
Raise:	`IllegalState` – syntax is not a `HEADING`
Raise:	`NullArgument` – `heading_type` is `null`
Raise:	`Unsupported` – `supports_heading_type(heading_type)` is `false`

get_maximum_heading_values(heading_type)¶

Gets the maximum heading values given supported heading type.

Parameters:	heading_type (`osid.type.Type`) – a heading Type
Returns:	the maximum heading values
Return type:	`decimal`
Raise:	`IllegalState` – syntax is not a `HEADING`
Raise:	`NullArgument` – `heading_type` is `null`
Raise:	`Unsupported` – `supports_heading_type(heading_type)` is `false`

heading_set¶

Gets the set of acceptable heading values.

Returns:	the set of heading
Return type:	`osid.mapping.Heading`
Raise:	`IllegalState` – syntax is not a `HEADING`

default_heading_values¶

Gets the default heading values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default heading values
Return type:	`osid.mapping.Heading`
Raise:	`IllegalState` – syntax is not a `HEADING` or `is_required()` is `true`

existing_heading_values¶

Gets the existing heading values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing heading values
Return type:	`osid.mapping.Heading`
Raise:	`IllegalState` – syntax is not a `HEADING` or `is_value_known()` is `false`

id_set¶

Gets the set of acceptable Ids.

Returns:	a set of `Ids` or an empty array if not restricted
Return type:	`osid.id.Id`
Raise:	`IllegalState` – syntax is not an `ID`

default_id_values¶

Gets the default Id values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default `Id` values
Return type:	`osid.id.Id`
Raise:	`IllegalState` – syntax is not an `ID` or `is_required()` is `true`

existing_id_values¶

Gets the existing Id values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing `Id` values
Return type:	`osid.id.Id`
Raise:	`IllegalState` – syntax is not an `ID`

minimum_integer¶

Gets the minimum integer value.

Returns:	the minimum value
Return type:	`integer`
Raise:	`IllegalState` – syntax is not an `INTEGER`

maximum_integer¶

Gets the maximum integer value.

Returns:	the maximum value
Return type:	`integer`
Raise:	`IllegalState` – syntax is not an `INTEGER`

integer_set¶

Gets the set of acceptable integer values.

Returns:	a set of values or an empty array if not restricted
Return type:	`integer`
Raise:	`IllegalState` – syntax is not an `INTEGER`

default_integer_values¶

Gets the default integer values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default integer values
Return type:	`integer`
Raise:	`IllegalState` – syntax is not an `INTEGER` or `is_required()` is `true`

existing_integer_values¶

Gets the existing integer values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing integer values
Return type:	`integer`
Raise:	`IllegalState` – syntax is not a `INTEGER` or isValueKnown() is false

object_types¶

Gets the set of acceptable Types for an arbitrary object.

Returns:	a set of `Types` or an empty array if not restricted
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not an `OBJECT`

supports_object_type(object_type)¶

Tests if the given object type is supported.

Parameters:	object_type (`osid.type.Type`) – an object Type
Returns:	`true` if the type is supported, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – syntax is not an `OBJECT`
Raise:	`NullArgument` – `object_type` is `null`

object_set¶

Gets the set of acceptable object values.

Returns:	a set of values or an empty array if not restricted
Return type:	`object`
Raise:	`IllegalState` – syntax is not an `OBJECT`

default_object_values¶

Gets the default object values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default object values
Return type:	`object`
Raise:	`IllegalState` – syntax is not an `OBJECT` or `is_required()` is `true`

existing_object_values¶

Gets the existing object values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing object values
Return type:	`object`
Raise:	`IllegalState` – syntax is not an OBJECT or `is_value_known()` is `false`

spatial_unit_record_types¶

Gets the set of acceptable spatial unit record types.

Returns:	the set of spatial unit types
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not `SPATIALUNIT`

supports_spatial_unit_record_type(spatial_unit_record_type)¶

Tests if the given spatial unit record type is supported.

Parameters:	spatial_unit_record_type (`osid.type.Type`) – a spatial unit record Type
Returns:	`true` if the type is supported, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – syntax is not an `SPATIALUNIT`
Raise:	`NullArgument` – `spatial_unit_record_type` is `null`

spatial_unit_set¶

Gets the set of acceptable spatial unit values.

Returns:	a set of spatial units or an empty array if not restricted
Return type:	`osid.mapping.SpatialUnit`
Raise:	`IllegalState` – syntax is not a `SPATIALUNIT`

default_spatial_unit_values¶

Gets the default spatial unit values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default spatial unit values
Return type:	`osid.mapping.SpatialUnit`
Raise:	`IllegalState` – syntax is not a `SPATIALUNIT` or `is_required()` is `true`

existing_spatial_unit_values¶

Gets the existing spatial unit values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing spatial unit values
Return type:	`osid.mapping.SpatialUnit`
Raise:	`IllegalState` – syntax is not a SPATIALUNIT or `is_value_known()` is `false`

minimum_speed¶

Gets the minimum speed value.

Returns:	the minimum speed
Return type:	`osid.mapping.Speed`
Raise:	`IllegalState` – syntax is not a `SPEED`

maximum_speed¶

Gets the maximum speed value.

Returns:	the maximum speed
Return type:	`osid.mapping.Speed`
Raise:	`IllegalState` – syntax is not a `SPEED`

speed_set¶

Gets the set of acceptable speed values.

Returns:	a set of speeds or an empty array if not restricted
Return type:	`osid.mapping.Speed`
Raise:	`IllegalState` – syntax is not a `SPEED`

default_speed_values¶

Gets the default speed values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default speed values
Return type:	`osid.mapping.Speed`
Raise:	`IllegalState` – syntax is not a `SPEED` or `is_required()` is `true`

existing_speed_values¶

Gets the existing speed values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing speed values
Return type:	`osid.mapping.Speed`
Raise:	`IllegalState` – syntax is not a `SPEED` or `is_value_known()` is `false`

minimum_string_length¶

Gets the minimum string length.

Returns:	the minimum string length
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `STRING`

maximum_string_length¶

Gets the maximum string length.

Returns:	the maximum string length
Return type:	`cardinal`
Raise:	`IllegalState` – syntax is not a `STRING`

string_match_types¶

Gets the set of valid string match types for use in validating a string.

If the string match type indicates a regular expression then get_string_expression() returns a regular expression.

Returns:	the set of string match types
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `STRING`

supports_string_match_type(string_match_type)¶

Tests if the given string match type is supported.

Parameters:	string_match_type (`osid.type.Type`) – a string match type
Returns:	`true` if the given string match type Is supported, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – syntax is not a `STRING`
Raise:	`NullArgument` – `string_match_type` is `null`

get_string_expression(string_match_type)¶

Gets the regular expression of an acceptable string for the given string match type.

Parameters:	string_match_type (`osid.type.Type`) – a string match type
Returns:	the regular expression
Return type:	`string`
Raise:	`NullArgument` – `string_match_type` is `null`
Raise:	`IllegalState` – syntax is not a `STRING`
Raise:	`Unsupported` – `supports_string_match_type(string_match_type` ) is `false`

string_format_types¶

Gets the set of valid string formats.

Returns:	the set of valid text format types
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `STRING`

string_set¶

Gets the set of acceptable string values.

Returns:	a set of strings or an empty array if not restricted
Return type:	`string`
Raise:	`IllegalState` – syntax is not a `STRING`

default_string_values¶

Gets the default string values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default string values
Return type:	`string`
Raise:	`IllegalState` – syntax is not a `STRING` or `is_required()` is `true`

existing_string_values¶

Gets the existing string values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing string values
Return type:	`string`
Raise:	`IllegalState` – syntax is not a `STRING` or `is_value_known()` is `false`

minimum_time¶

Gets the minimum time value.

Returns:	the minimum time
Return type:	`osid.calendaring.Time`
Raise:	`IllegalState` – syntax is not a `TIME`

maximum_time¶

Gets the maximum time value.

Returns:	the maximum time
Return type:	`osid.calendaring.Time`
Raise:	`IllegalState` – syntax is not a `TIME`

time_set¶

Gets the set of acceptable time values.

Returns:	a set of times or an empty array if not restricted
Return type:	`osid.calendaring.Time`
Raise:	`IllegalState` – syntax is not a `TIME`

default_time_values¶

Gets the default time values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default time values
Return type:	`osid.calendaring.Time`
Raise:	`IllegalState` – syntax is not a `TIME` or `is_required()` is `true`

existing_time_values¶

Gets the existing time values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing time values
Return type:	`osid.calendaring.Time`
Raise:	`IllegalState` – syntax is not a `TIME` or `is_value_known()` is `false`

type_set¶

Gets the set of acceptable Types.

Returns:	a set of `Types` or an empty array if not restricted
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `TYPE`

default_type_values¶

Gets the default type values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default type values
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `TYPE` or `is_required()` is `true`

existing_type_values¶

Gets the existing type values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing type values
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `TYPE` or `is_value_known()` is `false`

version_types¶

Gets the set of acceptable version types.

Returns:	the set of version types
Return type:	`osid.type.Type`
Raise:	`IllegalState` – syntax is not a `VERSION`

supports_version_type(version_type)¶

Tests if the given version type is supported.

Parameters:	version_type (`osid.type.Type`) – a version Type
Returns:	`true` if the type is supported, `false` otherwise
Return type:	`boolean`
Raise:	`IllegalState` – syntax is not a `VERSION`
Raise:	`NullArgument` – `version_type` is `null`

minimum_version¶

Gets the minumim acceptable Version.

Returns:	the minumim `Version`
Return type:	`osid.installation.Version`
Raise:	`IllegalState` – syntax is not a `VERSION`

maximum_version¶

Gets the maximum acceptable Version.

Returns:	the maximum `Version`
Return type:	`osid.installation.Version`
Raise:	`IllegalState` – syntax is not a `VERSION`

version_set¶

Gets the set of acceptable Versions.

Returns:	a set of `Versions` or an empty array if not restricted
Return type:	`osid.installation.Version`
Raise:	`IllegalState` – syntax is not a `VERSION`

default_version_values¶

Gets the default version values.

These are the values used if the element value is not provided or is cleared. If is_array() is false, then this method returns at most a single value.

Returns:	the default version values
Return type:	`osid.installation.Version`
Raise:	`IllegalState` – syntax is not a TIME or isValueKnown() is false

existing_version_values¶

Gets the existing version values.

If has_value() and is_required() are false, then these values are the default values ``. If ``is_array() is false, then this method returns at most a single value.

Returns:	the existing version values
Return type:	`osid.installation.Version`
Raise:	`IllegalState` – syntax is not a `VERSION` or `is_value_known()` is `false`