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.
Modifier and Type | Method and Description |
---|---|
CatalogueRecord |
getCatalogueRecord(Type catalogueRecordType)
Gets the record corresponding to the given
Catalogue
record Type. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CatalogueRecord getCatalogueRecord(Type catalogueRecordType) throws OperationFailedException
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
.catalogueRecordType
- the type of catalogue record to retrieveNullArgumentException
- catalogueRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(catalogueRecordType)
is false
mandatory
- This method must be implemented.