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

Interface	osid.resource.demographic.DemographicEnablerRuleLookupSession
Implements	`osid.OsidSession`
Used By	`osid.resource.demographic.ResourceDemographicManager`
Used By	`osid.resource.demographic.ResourceDemographicProxyManager`
Description	This session provides methods to retrieve `DemographicEnabler` to `Demographic` mappings. A `Demographic` with multiple `DemographicEnablers` means any positive rule evaluation across the enablers result in an effective `Demographic`. This lookup session defines several views: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition isolated bin view: All methods in this session operate, retrieve and pertain demographic enablers defined explicitly in the current bin federated bin view: All methods in this session operate, retrieve and pertain to all demographic enablers defined in this bin and any other demographic enablers implicitly available in this bin through bin inheritence.
Method	getBinId
Description	Gets the `Bin` `Id` associated with this session.
Return	`osid.id.Id`		the `Bin Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBin
Description	Gets the `Bin` associated with this session.
Return	`osid.resource.Bin`		the bin
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupDemographicEnablerRules
Description	Tests if this user can perform lookups of demographic enabler/demographic mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeDemographicEnablerRuleView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryDemographicEnablerRuleView
Description	A complete view of the `DemographicEnabler` and `Demographic` returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
Compliance	`mandatory`		This method is must be implemented.
Method	useFederatedBinView
Description	Federates the view for methods in this session. A federated view will include demographic enablers in bins which are children of this bin in the bin hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBinView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this bin only.
Compliance	`mandatory`		This method is must be implemented.
Method	getDemographicEnablerIdsForDemographic
Description	Gets the `DemographicEnabler Id` associated with a `Demographic`.
Parameters	`osid.id.Id`	`demographicId`	`Id` of the `Demographic`
Return	`osid.id.IdList`		the demographic enabler `Ids`
Errors	NOT_FOUND		`demographicId` is not found
	NULL_ARGUMENT		`demographicId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablersForDemographic
Description	Gets the `DemographicEnabler` associated with a `Demographic`.
Parameters	`osid.id.Id`	`demographicId`	`Id` of the `Demographic`
Return	`osid.resource.demographic.DemographicEnablerList`		the demographic enablers
Errors	NOT_FOUND		`demographicId` is not found
	NULL_ARGUMENT		`demographicId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicIdsForDemographicEnabler
Description	Gets the `Demographic` `Ids` mapped to a `DemographicEnabler`.
Parameters	`osid.id.Id`	`demographicEnablerId`	`Id` of a `DemographicEnabler`
Return	`osid.id.IdList`		list of demographic `Ids`
Errors	NOT_FOUND		`demographicEnablerId` is not found
	NULL_ARGUMENT		`demographicEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicsForDemographicEnabler
Description	Gets the `Demographics` mapped to a `DemographicEnabler`.
Parameters	`osid.id.Id`	`demographicEnablerId`	`Id` of a `DemographicEnabler`
Return	`osid.resource.demographic.DemographicList`		list of demographics
Errors	NOT_FOUND		`demographicEnablerId` is not found
	NULL_ARGUMENT		`demographicEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.