org.osid.configuration

Interface Configuration

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Configuration
extends OsidCatalog

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

Method Summary

Methods

Modifier and Type	Method and Description
ConfigurationRecord	getConfigurationRecord(Type configurationRecordType) Gets the configuration record corresponding to the given Configuration record Type.
boolean	isRegistry() Tests if this configuration is a parameter registry.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

isRegistry

boolean isRegistry()

Tests if this configuration is a parameter registry. A parameter registry contains parameter definitions with no values.

Returns:

true if this is a registry, false otherwise

Compliance:

mandatory - This method must be implemented.

getConfigurationRecord

ConfigurationRecord getConfigurationRecord(Type configurationRecordType)
                                           throws OperationFailedException

Gets the configuration record corresponding to the given Configuration record Type. This method is used to retrieve an object implementing the requested record. The configurationRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(configurationRecordType) is true .

Parameters:

configurationRecordType - the type of configuration record to retrieve

Returns:

the configuration record

Throws:

NullArgumentException - configurationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(configurationRecordType) is false

Compliance:

mandatory - This method must be implemented.