OSID Logo
OSID Specifications
cataloging package
Version 3.1.0
Interfaceosid.cataloging.Catalog
Implementsosid.OsidCatalog
Used Byosid.cataloging.CatalogAdminSession
osid.cataloging.CatalogEntryNotificationSession
osid.cataloging.CatalogList
osid.cataloging.CatalogLookupSession
osid.cataloging.CatalogNode
osid.cataloging.rules.CatalogEnablerAdminSession
osid.cataloging.rules.CatalogEnablerLookupSession
osid.cataloging.rules.CatalogEnablerNotificationSession
osid.cataloging.rules.CatalogEnablerQuerySession
osid.cataloging.rules.CatalogEnablerRuleApplicationSession
show 2 more…
osid.cataloging.rules.CatalogEnablerRuleLookupSession
osid.cataloging.rules.CatalogEnablerSmartCatalogSession
Description

A Catalog represents a collection of entries. Like all OsidObjects, 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.

Like all OsidObjects, Catalog is managed by its OsidSessions and may not be accessed by concurrent processing threads.

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.TypecatalogRecordType a type of the record to retrieve
Returnosid.cataloging.records.CatalogRecord the catalog record
ErrorsNULL_ARGUMENT catalogRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(catalogRecordType) is false
Compliancemandatory This method must be implemented.