org.osid.cataloging

Interface Catalog

All Superinterfaces:

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

public interface Catalog
extends OsidCatalog

A Catalog represents a collection of entries. Like all OSID objects, a Catalog is identified by its Id and any persisted references should use the Id.

getCatalogRecord() should be used to retrieve any record corresponding to arecord Type. The existence of the record must not be assumed until requested at which point it is safe to cast into the record indicated by the type.

Method Summary

Methods

Modifier and Type	Method and Description
CatalogRecord	getCatalogRecord(Type catalogRecordType) Gets the catalog record corresponding to the given Catalog 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

getCatalogRecord

CatalogRecord getCatalogRecord(Type catalogRecordType)
                               throws OperationFailedException

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

Parameters:

catalogRecordType - a type of the record to retrieve

Returns:

the catalog record

Throws:

NullArgumentException - catalogRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(catalogRecordType) is false

Compliance:

mandatory - This method must be implemented.