Interface | osid.cataloging.rules.CatalogingRulesProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.cataloging.rules.CatalogingRulesProfile | |||
Description |
The cataloging proxy manager provides access to cataloging
rules sessions and provides interoperability tests for various
aspects of this service. Methods in this manager pass a
| ||
Method | getCatalogEnablerLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.cataloging.rules.CatalogEnablerLookupSession | a CatalogEnablerLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogEnablerLookup()
is true. | |
Method | getCatalogEnablerLookupSessionForCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.cataloging.rules.CatalogEnablerLookupSession | a CatalogEnablerLookupSession | |
Errors | NOT_FOUND | no Catalog found by the given Id | |
NULL_ARGUMENT | catalogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogEnablerLookup()
and supportsVisibleFederation() are true.
| |
Method | getCatalogEnablerQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.cataloging.rules.CatalogEnablerQuerySession | a CatalogEnablerQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogEnablerQuery()
is true. | |
Method | getCatalogEnablerQuerySessionForCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.cataloging.rules.CatalogEnablerQuerySession | a CatalogEnablerQuerySession | |
Errors | NOT_FOUND | no Catalog found by the given Id | |
NULL_ARGUMENT | catalogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogEnablerQuery()
and supportsVisibleFederation() are true.
| |
Method | getCatalogEnablerSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.cataloging.rules.CatalogEnablerSearchSession | a CatalogEnablerSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogEnablerSearch()
is true. | |
Method | getCatalogEnablerSearchSessionForCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.cataloging.rules.CatalogEnablerSearchSession | a CatalogEnablerSearchSession | |
Errors | NOT_FOUND | no Catalog found by the given Id | |
NULL_ARGUMENT | catalogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogEnablerSearch()
and supportsVisibleFederation() are true.
| |
Method | getCatalogEnablerAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.cataloging.rules.CatalogEnablerAdminSession | a CatalogEnablerAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogEnablerAdmin()
is true. | |
Method | getCatalogEnablerAdminSessionForCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.cataloging.rules.CatalogEnablerAdminSession | a CatalogEnablerAdminSession | |
Errors | NOT_FOUND | no Catalog found by the given Id | |
NULL_ARGUMENT | catalogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogEnablerAdmin()
and supportsVisibleFederation() are true.
| |
Method | getCatalogEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.cataloging.rules.CatalogEnablerReceiver | catalogEnablerReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.cataloging.rules.CatalogEnablerNotificationSession | a CatalogEnablerNotificationSession | |
Errors | NULL_ARGUMENT | catalogEnablerReceiver or proxy is
null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsCatalogEnablerNotification() is true. | |
Method | getCatalogEnablerNotificationSessionForCatalog | ||
Description |
Gets the | ||
Parameters | osid.cataloging.rules.CatalogEnablerReceiver | catalogEnablerReceiver | the notification callback |
osid.id.Id | catalogId | the Id of the Catalog | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.cataloging.rules.CatalogEnablerNotificationSession | a CatalogEnablerNotificationSession | |
Errors | NOT_FOUND | no catalog found by the given Id | |
NULL_ARGUMENT | catalogEnablerReceiver, catalogId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsCatalogEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getCatalogEnablerCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.cataloging.rules.CatalogEnablerCatalogSession | a CatalogEnablerCatalogSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerCatalog() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogEnablerCatalog()
is true. | |
Method | getCatalogEnablerCatalogAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.cataloging.rules.CatalogEnablerCatalogAssignmentSession | a CatalogEnablerCatalogAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerCatalogAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsCatalogEnablerCatalogAssignment() is true. | |
Method | getCatalogEnablerSmartCatalogSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.cataloging.rules.CatalogEnablerSmartCatalogSession | a CatalogEnablerSmartCatalogSession | |
Errors | NOT_FOUND | no Catalog found by the given Id | |
NULL_ARGUMENT | catalogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerSmartCatalog() is false | ||
Compliance | optional | This method must be implemented if
supportsCatalogEnablerSmartCatalog() is true. | |
Method | getCatalogEnablerRuleLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.cataloging.rules.CatalogEnablerRuleLookupSession | a CatalogEnablerRuleLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerRuleLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsCatalogEnablerRuleLookup() is true. | |
Method | getCatalogEnablerRuleLookupSessionForCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.cataloging.rules.CatalogEnablerRuleLookupSession | a CatalogEnablerRuleLookupSession | |
Errors | NOT_FOUND | no Catalog found by the given Id | |
NULL_ARGUMENT | catalogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsCatalogEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
Method | getCatalogEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.cataloging.rules.CatalogEnablerRuleApplicationSession | a CatalogEnablerRuleApplicationSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsCatalogEnablerRuleApplication() is true. | |
Method | getCatalogEnablerRuleApplicationSessionForCatalog | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogId | the Id of the Catalog |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.cataloging.rules.CatalogEnablerRuleApplicationSession | a CatalogEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no Catalog found by the given Id | |
NULL_ARGUMENT | catalogId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsCatalogEnablerRuleApplication() and
supportsVisibleFederation() are true |