OSID Logo
OSID Specifications
cataloging rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.cataloging.rules.CatalogEnabler
Implementsosid.OsidEnabler
Description

A CatalogEnabler describes the rules for enabling the Catalog in a federated hierarchy.

MethodgetCatalogEnablerRecord
Description

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

Parametersosid.type.TypecatalogEnablerRecordTypethe type of catalog enabler record to retrieve
Returnosid.cataloging.rules.records.CatalogEnablerRecordthe catalog enabler record
ErrorsNULL_ARGUMENT catalogEnablerRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(catalogEnablerRecordType) is false
CompliancemandatoryThis method must be implemented.