OSID — Configuration Entities

Parameter

Osid Rule

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.

Like all OsidObjects, Parameter is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise
OsidRule
`hasRule`	boolean		`true` if an explicit rule is available, `false` otherwise
`ruleId`	id		the rule `Id`
`rule`	Rule		the rule
`conditionRecordTypes`	type	⋆	a list of `OsidCondition` record `Types`

Name	Syntax	Description
`valueSyntax`	Syntax	the syntax of the values
`valueCoordinateType`	type	the type of the values
`valueHeadingType`	type	the type of the values
`valueObjectType`	type	the type of the values
`valueSpatialUnitRecordType`	type	the type of the values
`valueVersionScheme`	type	the type of the values
`areValuesShuffled`	boolean	`true` if the values are shuffled, `false` otherwise

Value

Osid Object Subjugateable

This interface specifies the value of a configuration parameter.

Like all OsidObjects, Value is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Operable
`isActive`	boolean		`true` if this operable is active, `false` if it is inactive
`isEnabled`	boolean		`true` if this operable is enabled, `false` if the active status is determined by other rules
`isDisabled`	boolean		`true` if this operable is disabled, `false` if the active status is determined by other rules
`isOperational`	boolean		`true` if this operable is operational, `false` otherwise

Name	Syntax	Description
`parameterId`	id	the parameter `Id`
`parameter`	Parameter	the parameter
`priority`	integer	the index of this value
`booleanValue`	boolean	the value
`bytesValue`	byte	the value
`cardinalValue`	cardinal	the value
`coordinateValue`	Coordinate	the value
`currencyValue`	Currency	the value
`dateTimeValue`	datetime	the value
`decimalValue`	decimal	the value
`displayTextValue`	displaytext	the value
`distanceValue`	Distance	the value
`durationValue`	duration	the value
`headingValue`	Heading	the value
`idValue`	id	the value
`integerValue`	integer	the value
`objectValue`	object	the value
`spatialUnitValue`	SpatialUnit	the value
`speedValue`	Speed	the value
`stringValue`	string	the value
`timeValue`	Time	the value
`typeValue`	type	the value
`versionValue`	Version	the value

Configuration

Osid Catalog

Configuration represents a configuration object. It contains a name, description and a set of properties that describe a configuration data set.

Like all OsidObjects, Configuration is managed by its OsidSessions and may not be accessed by concurrent processing threads.

Inherited elements

Name	Syntax	Many	Description
Identifiable
`id`	id		the `Id`
Extensible
`recordTypes`	type	⋆	the record types available
Browsable
`properties`	Property	⋆	a list of properties
OsidObject
`displayName`	displaytext		the display name
`description`	displaytext		the description
`genusType`	type		the genus type of this object
Sourceable
`providerId`	id		the provider `Id`
`provider`	Resource		the provider
`brandingIds`	id	⋆	a list of asset `Ids`
`branding`	Asset	⋆	a list of assets
`license`	displaytext		the license

Name	Syntax	Many	Description
`isRegistry`	boolean		`true` if this is a registry, `false` otherwise

Configuration

Parameters

Values

Configuration Cataloging

Sub Packages

Example

Parameter

Value

Configuration