org.osid.offering

Interface Catalogue

All Superinterfaces:

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

public interface Catalogue
extends OsidCatalog

A Catalogue represents a collection of canonical units and offerings. Like all OSID objects, a Catalogue is identified by its Id and any persisted references should use the Id.

Method Summary

Methods

Modifier and Type	Method and Description
CatalogueRecord	getCatalogueRecord(Type catalogueRecordType) Gets the record corresponding to the given Catalogue 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

getCatalogueRecord

CatalogueRecord getCatalogueRecord(Type catalogueRecordType)
                                   throws OperationFailedException

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

Parameters:

catalogueRecordType - the type of catalogue record to retrieve

Returns:

the catalogue record

Throws:

NullArgumentException - catalogueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogueRecordType) is false

Compliance:

mandatory - This method must be implemented.