org.osid.control

Interface System

All Superinterfaces:

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

public interface System
extends OsidCatalog

A System represents a collection of Devices, Inputs, Controllers, Settings, Triggers, ActionGroups, and Scenes.

Method Summary

Methods

Modifier and Type	Method and Description
SystemRecord	getSystemRecord(Type systemRecordType) Gets the system record corresponding to the given System record Type.

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

getSystemRecord

SystemRecord getSystemRecord(Type systemRecordType)
                             throws OperationFailedException

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

Parameters:

systemRecordType - the type of system record to retrieve

Returns:

the system record

Throws:

NullArgumentException - systemRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(systemRecordType) is false

Compliance:

mandatory - This method must be implemented.