org.osid.ontology

Interface Subject

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidObject

public interface Subject
extends OsidObject, Federateable

A Subject represents a span of time and an optional location. Subjects may be managed individually, or in repeatable sets using RecuringSubject.

Method Summary

Methods

Modifier and Type	Method and Description
SubjectRecord	getSubjectRecord(Type subjectRecordType) Gets the subject record corresponding to the given Subject 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

Method Detail

getSubjectRecord

SubjectRecord getSubjectRecord(Type subjectRecordType)
                               throws OperationFailedException

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

Parameters:

subjectRecordType - the type of the record to retrieve

Returns:

the subject record

Throws:

NullArgumentException - subjectRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(subjectRecordType) is false

Compliance:

mandatory - This method must be implemented.