OSID Logo
OSID Specifications
resource demographic package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.demographic.ResourceDemographicProxyManager
Implementsosid.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 Proxy for passing information from server environments. The sessions included in this manager are:

  • DemographicLookupSession: a session to retrieve demographic
  • DemographicQuerySession: a session to query for demographic
  • DemographicSearchSession: a session to search for demographic
  • DemographicAdminSession: a session to create and delete demographic
  • DemographicBuilderSession: a session to build demographics from searches
  • DemographicNotificationSession: a session to receive notifications pertaining to demographic changes
  • DemographicBinSession: a session to look up demographic bin mappings
  • DemographicBinAssignmentSession: a session to manage demographic to bin mappings
  • DemographicSmartBinSession: a session to manage dynamic bins of demographic
  • DemographicEnablerLookupSession: a session to retrieve demographic enablers
  • DemographicEnablerQuerySession: a session to query for demographic enablers
  • DemographicEnablerSearchSession: a session to search for demographic enablers
  • DemographicEnablerAdminSession: a session to create and delete demographic enablers
  • DemographicEnablerNotificationSession: a session to receive notifications pertaining to demographic enabler changes
  • DemographicEnablerBinSession: a session to look up demographic enabler bin mappings
  • DemographicEnablerBinAssignmentSession: a session to manage demographic enabler to bin mappings
  • DemographicEnablerSmartBinSession: a session to manage dynamic bins of demographic enablers
  • DemographicEnablerRuleLookupSession: a session to look up demographic enabler mappings
  • DemographicEnablerRuleApplicationSession: a session to apply demographic enablers
MethodgetDemographicLookupSession
Description

Gets the OsidSession associated with the demographic lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicLookupSessiona DemographicLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicLookup() is false
ComplianceoptionalThis method must be implemented if supportsDemographicLookup() is true.
MethodgetDemographicLookupSessionForBin
Description

Gets the OsidSession associated with the demographic lookup service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicLookupSessiona DemographicLookupSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicLookup() and supportsVisibleFederation() are true.
MethodgetDemographicQuerySession
Description

Gets the OsidSession associated with the demographic query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicQuerySessiona DemographicQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicQuery() is false
ComplianceoptionalThis method must be implemented if supportsDemographicQuery() is true.
MethodgetDemographicQuerySessionForBin
Description

Gets the OsidSession associated with the demographic query service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicQuerySessiona DemographicQuerySession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicQuery() and supportsVisibleFederation() are true.
MethodgetDemographicSearchSession
Description

Gets the OsidSession associated with the demographic search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicSearchSessiona DemographicSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicSearch() is false
ComplianceoptionalThis method must be implemented if supportsDemographicSearch() is true.
MethodgetDemographicSearchSessionForBin
Description

Gets the OsidSession associated with the demographic earch service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicSearchSessiona DemographicSearchSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicSearch() and supportsVisibleFederation() are true.
MethodgetDemographicAdminSession
Description

Gets the OsidSession associated with the demographic administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicAdminSessiona DemographicAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDemographicAdmin() is true.
MethodgetDemographicAdminSessionForBin
Description

Gets the OsidSession associated with the demographic administration service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicAdminSessiona DemographicAdminSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicAdmin() and supportsVisibleFederation() are true.
MethodgetDemographicBuilderSession
Description

Gets the OsidSession associated with the demographic builder service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicBuilderSessiona DemographicBuilderSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicBuilder() is false
ComplianceoptionalThis method must be implemented if supportsDemographicBuilder() is true.
MethodgetDemographicBuilderSessionForBin
Description

Gets the OsidSession associated with the demographic builder service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicBuilderSessiona DemographicBuilderSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicBuilder() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicBuilder() and supportsVisibleFederation() are true.
MethodgetDemographicNotificationSession
Description

Gets the OsidSession associated with the demographic notification service.

Parametersosid.resource.demographic.DemographicReceiverdemographicReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicNotificationSessiona DemographicNotificationSession
ErrorsNULL_ARGUMENT demographicReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicNotification() is false
ComplianceoptionalThis method must be implemented if supportsDemographicNotification() is true.
MethodgetDemographicNotificationSessionForBin
Description

Gets the OsidSession associated with the demographic notification service for the given bin.

Parametersosid.resource.demographic.DemographicReceiverdemographicReceiverthe notification callback
osid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicNotificationSessiona DemographicNotificationSession
ErrorsNOT_FOUNDno bin found by the given Id
NULL_ARGUMENT demographicReceiver, binId, or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicNotification() and supportsVisibleFederation() are true.
MethodgetDemographicBinSession
Description

Gets the OsidSession to lookup demographic/bin mappings for demographics.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicBinSessiona DemographicBinSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicBin() is false
ComplianceoptionalThis method must be implemented if supportsDemographicBin() is true.
MethodgetDemographicBinAssignmentSession
Description

Gets the OsidSession associated with assigning demographic to bins.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicBinAssignmentSessiona DemographicBinAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicBinAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDemographicBinAssignment() is true.
MethodgetDemographicSmartBinSession
Description

Gets the OsidSession to manage demographic smart bins.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicSmartBinSessiona DemographicSmartBinSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicSmartBin() is false
ComplianceoptionalThis method must be implemented if supportsDemographicSmartBin() is true.
MethodgetDemographicEnablerLookupSession
Description

Gets the OsidSession associated with the demographic enabler lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerLookupSessiona DemographicEnablerLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerLookup() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerLookup() is true.
MethodgetDemographicEnablerLookupSessionForBin
Description

Gets the OsidSession associated with the demographic enabler lookup service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerLookupSessiona DemographicEnablerLookupSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerLookup() and supportsVisibleFederation() are true.
MethodgetDemographicEnablerQuerySession
Description

Gets the OsidSession associated with the demographic enabler query service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerQuerySessiona DemographicEnablerQuerySession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerQuery() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerQuery() is true.
MethodgetDemographicEnablerQuerySessionForBin
Description

Gets the OsidSession associated with the demographic enabler query service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerQuerySessiona DemographicEnablerQuerySession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerQuery() and supportsVisibleFederation() are true.
MethodgetDemographicEnablerSearchSession
Description

Gets the OsidSession associated with the demographic enabler search service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerSearchSessiona DemographicEnablerSearchSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerSearch() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerSearch() is true.
MethodgetDemographicEnablerSearchSessionForBin
Description

Gets the OsidSession associated with the demographic enablers earch service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerSearchSessiona DemographicEnablerSearchSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerSearch() and supportsVisibleFederation() are true.
MethodgetDemographicEnablerAdminSession
Description

Gets the OsidSession associated with the demographic enabler administration service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerAdminSessiona DemographicEnablerAdminSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerAdmin() is true.
MethodgetDemographicEnablerAdminSessionForBin
Description

Gets the OsidSession associated with the demographic enabler administration service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerAdminSessiona DemographicEnablerAdminSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerAdmin() and supportsVisibleFederation() are true.
MethodgetDemographicEnablerNotificationSession
Description

Gets the OsidSession associated with the demographic enabler notification service.

Parametersosid.resource.demographic.DemographicEnablerReceiverdemographicEnablerReceiverthe notification callback
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerNotificationSessiona DemographicEnablerNotificationSession
ErrorsNULL_ARGUMENT demographicEnablerReceiver or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerNotification() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerNotification() is true.
MethodgetDemographicEnablerNotificationSessionForBin
Description

Gets the OsidSession associated with the demographic enabler notification service for the given bin.

Parametersosid.resource.demographic.DemographicEnablerReceiverdemographicEnablerReceiverthe notification callback
osid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerNotificationSessiona DemographicEnablerNotificationSession
ErrorsNOT_FOUNDno bin found by the given Id
NULL_ARGUMENT demographicEnablerReceiver, binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerNotification() and supportsVisibleFederation() are true.
MethodgetDemographicEnablerBinSession
Description

Gets the OsidSession to lookup demographic enabler/bin mappings for demographic enablers.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerBinSessiona DemographicEnablerBinSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerBin() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerBin() is true.
MethodgetDemographicEnablerBinAssignmentSession
Description

Gets the OsidSession associated with assigning demographic enablers to bins.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerBinAssignmentSessiona DemographicEnablerBinAssignmentSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerBinAssignment() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerBinAssignment() is true.
MethodgetDemographicEnablerSmartBinSession
Description

Gets the OsidSession to manage demographic enabler smart bins.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerSmartBinSessiona DemographicEnablerSmartBinSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerSmartBin() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerSmartBin() is true.
MethodgetDemographicEnablerRuleLookupSession
Description

Gets the OsidSession associated with the demographic enabler mapping lookup service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerRuleLookupSessiona DemographicEnablerRuleLookupSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerRuleLookup() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerRuleLookup() is true.
MethodgetDemographicEnablerRuleLookupSessionForBin
Description

Gets the OsidSession associated with the demographic enabler mapping lookup service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerRuleLookupSessiona DemographicEnablerRuleLookupSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerRuleLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerRuleLookup() and supportsVisibleFederation() are true.
MethodgetDemographicEnablerRuleApplicationSession
Description

Gets the OsidSession associated with the demographic enabler assignment service.

Parametersosid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerRuleApplicationSessiona DemographicEnablerRuleApplicationSession
ErrorsNULL_ARGUMENT proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerRuleApplication() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerRuleApplication() is true.
MethodgetDemographicEnablerRuleApplicationSessionForBin
Description

Gets the OsidSession associated with the demographic enabler assignment service for the given bin.

Parametersosid.id.IdbinIdthe Id of the Bin
osid.proxy.Proxyproxya proxy
Returnosid.resource.demographic.DemographicEnablerRuleApplicationSessiona DemographicEnablerRuleApplicationSession
ErrorsNOT_FOUNDno Bin found by the given Id
NULL_ARGUMENT binId or proxy is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTED supportsDemographicEnablerRuleApplication() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDemographicEnablerRuleApplication() and supportsVisibleFederation() are true.