org.osid.inquiry

Interface Inquest

All Superinterfaces:

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

public interface Inquest
extends OsidCatalog

An Inquest represents a collection of reservoirs.

Method Summary

Methods

Modifier and Type	Method and Description
InquestRecord	getInquestRecord(Type inquestRecordType) Gets the inquest record corresponding to the given Inquest 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

getInquestRecord

InquestRecord getInquestRecord(Type inquestRecordType)
                               throws OperationFailedException

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

Parameters:

inquestRecordType - the type of inquest record to retrieve

Returns:

the inquest record

Throws:

NullArgumentException - inquestRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(inquestRecordType) is false

Compliance:

mandatory - This method must be implemented.