OSID Specifications
cataloging rules package
Version 3.1.0
cataloging rules package
Version 3.1.0
| Interface | osid.cataloging.rules.CatalogingRulesProfile | ||
|---|---|---|---|
| Implements | osid.OsidProfile | ||
| Implemented By | osid.cataloging.rules.CatalogingRulesManager | ||
osid.cataloging.rules.CatalogingRulesProxyManager | |||
| Description |
The cataloging rules profile describes the interoperability among cataloging rules services. | ||
| Method | supportsVisibleFederation | ||
| Description |
Tests if any broker federation is exposed. Federation is exposed when a specific broker may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of brokers appears as a single broker. | ||
| Return | boolean | true if visible federation is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerLookup | ||
| Description |
Tests if looking up catalog enablers is supported. | ||
| Return | boolean | true if catalog enabler lookup is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerQuery | ||
| Description |
Tests if querying catalog enablers is supported. | ||
| Return | boolean | true if catalog enabler query is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerSearch | ||
| Description |
Tests if searching catalog enablers is supported. | ||
| Return | boolean | true if catalog enabler search is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerAdmin | ||
| Description |
Tests if a catalog enabler administrative service is supported. | ||
| Return | boolean | true if catalog enabler administration is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerNotification | ||
| Description |
Tests if a catalog enabler notification service is supported. | ||
| Return | boolean | true if catalog enabler notification is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerCatalog | ||
| Description |
Tests if a catalog enabler catalog lookup service is supported. | ||
| Return | boolean | true if a catalog enabler catalog lookup service is
supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerCatalogAssignment | ||
| Description |
Tests if a catalog enabler catalog service is supported. | ||
| Return | boolean | true if catalog enabler catalog assignment service is
supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerSmartCatalog | ||
| Description |
Tests if a catalog enabler catalog lookup service is supported. | ||
| Return | boolean | true if a catalog enabler catalog service is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerRuleLookup | ||
| Description |
Tests if a catalog enabler rule lookup service is supported. | ||
| Return | boolean | true if a catalog enabler rule lookup service is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerRuleApplication | ||
| Description |
Tests if a catalog enabler rule application service is supported. | ||
| Return | boolean | true if catalog enabler rule application service is
supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogEnablerRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported CatalogEnabler record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | catalogEnablerRecordType | a Type indicating a CatalogEnabler record type |
| Return | boolean | true if the given record type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | catalogEnablerRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getCatalogEnablerSearchRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported CatalogEnabler search record
types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsCatalogEnablerSearchRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | catalogEnablerSearchRecordType | a Type indicating a CatalogEnabler search record
type |
| Return | boolean | true if the given search record type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | catalogEnablerSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |