OSID Specifications
cataloging package
Version 3.0.0
Release Candidate Preview
cataloging package
Version 3.0.0
Release Candidate Preview
| Interface | osid.cataloging.CatalogingProfile | ||
|---|---|---|---|
| Implements | osid.OsidProfile | ||
| Description |
The cataloging profile describes the interoperability among cataloging services. | ||
| Method | supportsVisibleFederation | ||
| Description |
Tests if any billing federation is exposed. Federation is exposed when a specific catalog may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of catalogs appears as a single catalog. | ||
| Return | boolean | true if visible federation is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalog | ||
| Description |
Tests for the availability of a cataloging service
retrieving | ||
| Return | boolean | true if cataloging is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogAssignment | ||
| Description |
Tests for the availability of a cataloging service for
mapping | ||
| Return | boolean | true if catalog assignment is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEntryNotification | ||
| Description |
Tests for the availability of a cataloging notification
service for mapping | ||
| Return | boolean | true if catalog entry notification is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogLookup | ||
| Description |
Tests for the availability of a catalog lookup service. | ||
| Return | boolean | true if catalog lookup is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogQuery | ||
| Description |
Tests for the availability of a catalog query service that defines more comprehensive queries. | ||
| Return | boolean | true if catalog query is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogSearch | ||
| Description |
Tests for the availability of a catalog search service that defines more comprehensive queries. | ||
| Return | boolean | true if catalog search is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogAdmin | ||
| Description |
Tests for the availability of a catalog administration service for the addition and deletion of catalogs. | ||
| Return | boolean | true if catalog administration is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogNotification | ||
| Description |
Tests for the availability of a catalog notification service. | ||
| Return | boolean | true if catalog notification is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogHierarchy | ||
| Description |
Tests for the availability of a catalog hierarchy traversal service. | ||
| Return | boolean | true if catalog hierarchy traversal is available,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogHierarchyDesign | ||
| Description |
Tests for the availability of a catalog hierarchy design service. | ||
| Return | boolean | true if catalog hierarchy design is available, false
otherwise | |
| Compliance | mandatory | This method must be implemented in all providers. | |
| Method | supportsCatalogingRules | ||
| Description |
Tests if the cataloging rules sub services is supported. | ||
| Return | boolean | true if cataloging rules is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported Catalog record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | catalogRecordType | a Type indicating a Catalog record type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | catalogRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogSearchRecordTypes | ||
| Description |
Gets the supported catalog search reciord types. | ||
| Return | osid.type.TypeList | a list containing the supported search record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogSearchRecordType | ||
| Description |
Tests if the given catalog search record type is supported. | ||
| Parameters | osid.type.Type | catalogSearchRecordType | a Type indicating a catalog search record type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | catalogSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |