Interface | osid.resource.demographic.ResourceDemographicProxyManager | ||
---|---|---|---|
Implements | osid.OsidProxyManager | ||
osid.resource.demographic.ResourceDemographicProfile | |||
Description |
The resource demographic proxy manager provides access to
resource demographic sessions and provides interoperability
tests for various aspects of this service. Methods in this
manager pass a
| ||
Method | getDemographicLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicLookupSession | a DemographicLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicLookup()
is true. | |
Method | getDemographicLookupSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicLookupSession | a DemographicLookupSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicLookup()
and supportsVisibleFederation() are true.
| |
Method | getDemographicQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicQuerySession | a DemographicQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicQuery() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicQuery()
is true. | |
Method | getDemographicQuerySessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicQuerySession | a DemographicQuerySession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicQuery()
and supportsVisibleFederation() are true.
| |
Method | getDemographicSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicSearchSession | a DemographicSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicSearch() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicSearch()
is true. | |
Method | getDemographicSearchSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicSearchSession | a DemographicSearchSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicSearch()
and supportsVisibleFederation() are true.
| |
Method | getDemographicAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicAdminSession | a DemographicAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicAdmin()
is true. | |
Method | getDemographicAdminSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicAdminSession | a DemographicAdminSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicAdmin()
and supportsVisibleFederation() are true.
| |
Method | getDemographicBuilderSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicBuilderSession | a DemographicBuilderSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicBuilder() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicBuilder()
is true. | |
Method | getDemographicBuilderSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicBuilderSession | a DemographicBuilderSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicBuilder() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicBuilder()
and supportsVisibleFederation() are true.
| |
Method | getDemographicNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.resource.demographic.DemographicReceiver | demographicReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicNotificationSession | a DemographicNotificationSession | |
Errors | NULL_ARGUMENT | demographicReceiver or proxy is null
| |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicNotification() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicNotification()
is true. | |
Method | getDemographicNotificationSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.resource.demographic.DemographicReceiver | demographicReceiver | the notification callback |
osid.id.Id | binId | the Id of the Bin | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicNotificationSession | a DemographicNotificationSession | |
Errors | NOT_FOUND | no bin found by the given Id | |
NULL_ARGUMENT | demographicReceiver, binId, or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicNotification()
and supportsVisibleFederation() are true.
| |
Method | getDemographicBinSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicBinSession | a DemographicBinSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicBin() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicBin()
is true. | |
Method | getDemographicBinAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicBinAssignmentSession | a DemographicBinAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicBinAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsDemographicBinAssignment() is true. | |
Method | getDemographicSmartBinSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicSmartBinSession | a DemographicSmartBinSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicSmartBin() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicSmartBin()
is true. | |
Method | getDemographicEnablerLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicEnablerLookupSession | a DemographicEnablerLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerLookup() is false | ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerLookup() is true. | |
Method | getDemographicEnablerLookupSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicEnablerLookupSession | a DemographicEnablerLookupSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerLookup() and
supportsVisibleFederation() are true. | |
Method | getDemographicEnablerQuerySession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicEnablerQuerySession | a DemographicEnablerQuerySession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerQuery() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicEnablerQuery()
is true. | |
Method | getDemographicEnablerQuerySessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicEnablerQuerySession | a DemographicEnablerQuerySession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicEnablerQuery()
and supportsVisibleFederation() are true.
| |
Method | getDemographicEnablerSearchSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicEnablerSearchSession | a DemographicEnablerSearchSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerSearch() is false | ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerSearch() is true. | |
Method | getDemographicEnablerSearchSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicEnablerSearchSession | a DemographicEnablerSearchSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerSearch() and
supportsVisibleFederation() are true. | |
Method | getDemographicEnablerAdminSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicEnablerAdminSession | a DemographicEnablerAdminSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicEnablerAdmin()
is true. | |
Method | getDemographicEnablerAdminSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicEnablerAdminSession | a DemographicEnablerAdminSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicEnablerAdmin()
and supportsVisibleFederation() are true.
| |
Method | getDemographicEnablerNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.resource.demographic.DemographicEnablerReceiver | demographicEnablerReceiver | the notification callback |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicEnablerNotificationSession | a DemographicEnablerNotificationSession | |
Errors | NULL_ARGUMENT | demographicEnablerReceiver or proxy is
null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerNotification() is false
| ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerNotification() is true. | |
Method | getDemographicEnablerNotificationSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.resource.demographic.DemographicEnablerReceiver | demographicEnablerReceiver | the notification callback |
osid.id.Id | binId | the Id of the Bin | |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicEnablerNotificationSession | a DemographicEnablerNotificationSession | |
Errors | NOT_FOUND | no bin found by the given Id | |
NULL_ARGUMENT | demographicEnablerReceiver, binId or proxy is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerNotification() and
supportsVisibleFederation() are true. | |
Method | getDemographicEnablerBinSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicEnablerBinSession | a DemographicEnablerBinSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerBin() is false | ||
Compliance | optional | This method must be implemented if supportsDemographicEnablerBin()
is true. | |
Method | getDemographicEnablerBinAssignmentSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicEnablerBinAssignmentSession | a DemographicEnablerBinAssignmentSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerBinAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerBinAssignment() is true. | |
Method | getDemographicEnablerSmartBinSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicEnablerSmartBinSession | a DemographicEnablerSmartBinSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerSmartBin() is false | ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerSmartBin() is true. | |
Method | getDemographicEnablerRuleLookupSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicEnablerRuleLookupSession | a DemographicEnablerRuleLookupSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerRuleLookup() is false
| ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerRuleLookup() is true. | |
Method | getDemographicEnablerRuleLookupSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicEnablerRuleLookupSession | a DemographicEnablerRuleLookupSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerRuleLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerRuleLookup() and
supportsVisibleFederation() are true. | |
Method | getDemographicEnablerRuleApplicationSession | ||
Description |
Gets the | ||
Parameters | osid.proxy.Proxy | proxy | a proxy |
Return | osid.resource.demographic.DemographicEnablerRuleApplicationSession | a DemographicEnablerRuleApplicationSession | |
Errors | NULL_ARGUMENT | proxy is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerRuleApplication() is false
| ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerRuleApplication() is true. | |
Method | getDemographicEnablerRuleApplicationSessionForBin | ||
Description |
Gets the | ||
Parameters | osid.id.Id | binId | the Id of the Bin |
osid.proxy.Proxy | proxy | a proxy | |
Return | osid.resource.demographic.DemographicEnablerRuleApplicationSession | a DemographicEnablerRuleApplicationSession | |
Errors | NOT_FOUND | no Bin found by the given Id | |
NULL_ARGUMENT | binId or proxy is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDemographicEnablerRuleApplication() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsDemographicEnablerRuleApplication() and
supportsVisibleFederation() are true. |