OSID Logo
OSID Specifications
cataloging package
Version 3.0.0
Release Candidate Preview
Interfaceosid.cataloging.Catalog
Implementsosid.OsidCatalog
Description

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.

MethodgetCatalogRecord
Description

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 .

Parametersosid.type.TypecatalogRecordTypea type of the record to retrieve
Returnosid.cataloging.records.CatalogRecordthe catalog record
ErrorsNULL_ARGUMENT catalogRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(catalogRecordType) is false
CompliancemandatoryThis method must be implemented.