OSID - osid.resource.demographic.ResourceDemographicManager Service Interface Definition

Interface	osid.resource.demographic.ResourceDemographicManager
Implements	`osid.OsidManager`
Implements	`osid.resource.demographic.ResourceDemographicProfile`
Description	The resource demographic manager provides access to resource demographic sessions and provides interoperability tests for various aspects of this service. 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
Method	getDemographicLookupSession
Description	Gets the `OsidSession` associated with the demographic lookup service.
Return	`osid.resource.demographic.DemographicLookupSession`		a `DemographicLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicLookup()` is `true.`
Method	getDemographicLookupSessionForBin
Description	Gets the `OsidSession` associated with the demographic lookup service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicLookupSession`		a `DemographicLookupSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic query service.
Return	`osid.resource.demographic.DemographicQuerySession`		a `DemographicQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicQuery()` is `true.`
Method	getDemographicQuerySessionForBin
Description	Gets the `OsidSession` associated with the demographic query service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicQuerySession`		a `DemographicQuerySession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic search service.
Return	`osid.resource.demographic.DemographicSearchSession`		a `DemographicSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicSearch()` is `true.`
Method	getDemographicSearchSessionForBin
Description	Gets the `OsidSession` associated with the demographic earch service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicSearchSession`		a `DemographicSearchSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic administration service.
Return	`osid.resource.demographic.DemographicAdminSession`		a `DemographicAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicAdmin()` is `true.`
Method	getDemographicAdminSessionForBin
Description	Gets the `OsidSession` associated with the demographic administration service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicAdminSession`		a `DemographicAdminSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic builder service.
Return	`osid.resource.demographic.DemographicBuilderSession`		a `DemographicBuilderSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicBuilder()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicBuilder()` is `true.`
Method	getDemographicBuilderSessionForBin
Description	Gets the `OsidSession` associated with the demographic builder service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicBuilderSession`		a `DemographicBuilderSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic notification service.
Parameters	`osid.resource.demographic.DemographicReceiver`	`demographicReceiver`	the notification callback
Return	`osid.resource.demographic.DemographicNotificationSession`		a `DemographicNotificationSession`
Errors	NULL_ARGUMENT		`demographicReceiver` 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 `OsidSession` associated with the demographic notification service for the given bin.
Parameters	`osid.resource.demographic.DemographicReceiver`	`demographicReceiver`	the notification callback
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicNotificationSession`		a `DemographicNotificationSession`
Errors	NOT_FOUND		no bin found by the given `Id`
	NULL_ARGUMENT		`demographicReceiver` or `binId` 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 `OsidSession` to lookup demographic/bin mappings for demographics.
Return	`osid.resource.demographic.DemographicBinSession`		a `DemographicBinSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicBin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicBin()` is `true.`
Method	getDemographicBinAssignmentSession
Description	Gets the `OsidSession` associated with assigning demographic to bins.
Return	`osid.resource.demographic.DemographicBinAssignmentSession`		a `DemographicBinAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicBinAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicBinAssignment()` is `true.`
Method	getDemographicSmartBinSession
Description	Gets the `OsidSession` to manage demographic smart bins.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicSmartBinSession`		a `DemographicSmartBinSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic enabler lookup service.
Return	`osid.resource.demographic.DemographicEnablerLookupSession`		a `DemographicEnablerLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicEnablerLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicEnablerLookup()` is `true.`
Method	getDemographicEnablerLookupSessionForBin
Description	Gets the `OsidSession` associated with the demographic enabler lookup service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicEnablerLookupSession`		a `DemographicEnablerLookupSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic enabler query service.
Return	`osid.resource.demographic.DemographicEnablerQuerySession`		a `DemographicEnablerQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicEnablerQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicEnablerQuery()` is `true.`
Method	getDemographicEnablerQuerySessionForBin
Description	Gets the `OsidSession` associated with the demographic enabler query service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicEnablerQuerySession`		a `DemographicEnablerQuerySession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic enabler search service.
Return	`osid.resource.demographic.DemographicEnablerSearchSession`		a `DemographicEnablerSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicEnablerSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicEnablerSearch()` is `true.`
Method	getDemographicEnablerSearchSessionForBin
Description	Gets the `OsidSession` associated with the demographic enablers earch service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicEnablerSearchSession`		a `DemographicEnablerSearchSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic enabler administration service.
Return	`osid.resource.demographic.DemographicEnablerAdminSession`		a `DemographicEnablerAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicEnablerAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicEnablerAdmin()` is `true.`
Method	getDemographicEnablerAdminSessionForBin
Description	Gets the `OsidSession` associated with the demographic enabler administration service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicEnablerAdminSession`		a `DemographicEnablerAdminSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic enabler notification service.
Parameters	`osid.resource.demographic.DemographicEnablerReceiver`	`demographicEnablerReceiver`	the notification callback
Return	`osid.resource.demographic.DemographicEnablerNotificationSession`		a `DemographicEnablerNotificationSession`
Errors	NULL_ARGUMENT		`demographicEnablerReceiver` 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 `OsidSession` associated with the demographic enabler notification service for the given bin.
Parameters	`osid.resource.demographic.DemographicEnablerReceiver`	`demographicEnablerReceiver`	the notification callback
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicEnablerNotificationSession`		a `DemographicEnablerNotificationSession`
Errors	NOT_FOUND		no bin found by the given `Id`
	NULL_ARGUMENT		`demographicEnablerReceiver` or `binId` 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 `OsidSession` to lookup demographic enabler/bin mappings for demographic enablers.
Return	`osid.resource.demographic.DemographicEnablerBinSession`		a `DemographicEnablerBinSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicEnablerBin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicEnablerBin()` is `true.`
Method	getDemographicEnablerBinAssignmentSession
Description	Gets the `OsidSession` associated with assigning demographic enablers to bins.
Return	`osid.resource.demographic.DemographicEnablerBinAssignmentSession`		a `DemographicEnablerBinAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicEnablerBinAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicEnablerBinAssignment()` is `true.`
Method	getDemographicEnablerSmartBinSession
Description	Gets the `OsidSession` to manage demographic enabler smart bins.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicEnablerSmartBinSession`		a `DemographicEnablerSmartBinSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic enabler mapping lookup service.
Return	`osid.resource.demographic.DemographicEnablerRuleLookupSession`		a `DemographicEnablerRuleLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicEnablerRuleLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicEnablerRuleLookup()` is `true.`
Method	getDemographicEnablerRuleLookupSessionForBin
Description	Gets the `OsidSession` associated with the demographic enabler mapping lookup service.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicEnablerRuleLookupSession`		a `DemographicEnablerRuleLookupSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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 `OsidSession` associated with the demographic enabler assignment service.
Return	`osid.resource.demographic.DemographicEnablerRuleApplicationSession`		a `DemographicEnablerRuleApplicationSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDemographicEnablerRuleApplication()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDemographicEnablerRuleApplication()` is `true.`
Method	getDemographicEnablerRuleApplicationSessionForBin
Description	Gets the `OsidSession` associated with the demographic enabler assignment service for the given bin.
Parameters	`osid.id.Id`	`binId`	the `Id` of the `Bin`
Return	`osid.resource.demographic.DemographicEnablerRuleApplicationSession`		a `DemographicEnablerRuleApplicationSession`
Errors	NOT_FOUND		no `Bin` found by the given `Id`
	NULL_ARGUMENT		`binId` 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.`