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

Interface	osid.resource.demographic.DemographicEnablerLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `DemographicEnablers.` This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated bin view: All demographic enabler methods in this session operate, retrieve and pertain to demographic enablers defined explicitly in the current bin. Using an isolated view is useful for managing `DemographicEnablers` with the `DemographicEnablerAdminSession.` federated bin view: All demographic enabler 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. active demographic enabler view: All demographic enabler lookup methods return active demographic enablers. any status demographic enabler view:Ddemographic enablers of any active or inactive status are returned from methods. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedDistributorView()` and `useIsolatedDistributorView()` behave as a radio group and one should be selected before invoking the methods in this session.
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	canLookupDemographicEnablers
Description	Tests if this user can perform `DemographicEnablers` lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeDemographicEnablerView
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	usePlenaryDemographicEnablerView
Description	A complete view of the `DemographicEnabler` 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	useActiveDemographicEnablerView
Description	Only active demographic enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusDemographicEnablerView
Description	All active and inactive demographic enablers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getDemographicEnabler
Description	Gets the `DemographicEnabler` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `DemographicEnabler` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `DemographicEnabler` and retained for compatibility. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.id.Id`	`demographicEnablerId`	`Id` of the `DemographicEnabler`
Return	`osid.resource.demographic.DemographicEnabler`		the demographic enabler
Errors	NOT_FOUND		`demographicEnablerId` not found
	NULL_ARGUMENT		`demographicEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getDemographicEnablersByIds
Description	Gets a `DemographicEnablerList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the demographic enablers specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `DemographicEnablers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.id.IdList`	`demographicEnablerIds`	the list of `Ids` to retrieve
Return	`osid.resource.demographic.DemographicEnablerList`		the returned `DemographicEnabler` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`demographicEnablerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablersByGenusType
Description	Gets a `DemographicEnablerList` corresponding to the given demographic enabler genus `Type` which does not include demographic enablers of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known demographic enablers or an error results. Otherwise, the returned list may contain only those demographic enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.type.Type`	`demographicEnablerGenusType`	a demographic enabler genus type
Return	`osid.resource.demographic.DemographicEnablerList`		the returned `DemographicEnabler` list
Errors	NULL_ARGUMENT		`demographicEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablersByParentGenusType
Description	Gets a `DemographicEnablerList` corresponding to the given demographic enabler genus `Type` and include any additional demographic enablers with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known demographic enablers or an error results. Otherwise, the returned list may contain only those demographic enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.type.Type`	`demographicEnablerGenusType`	a demographic enabler genus type
Return	`osid.resource.demographic.DemographicEnablerList`		the returned `DemographicEnabler` list
Errors	NULL_ARGUMENT		`demographicEnablerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablersByRecordType
Description	Gets a `DemographicEnablerList` containing the given demographic enabler record `Type.` In plenary mode, the returned list contains all known demographic enablers or an error results. Otherwise, the returned list may contain only those demographic enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Parameters	`osid.type.Type`	`demographicEnablerRecordType`	a demographic enabler record type
Return	`osid.resource.demographic.DemographicEnablerList`		the returned `DemographicEnabler` list
Errors	NULL_ARGUMENT		`demographicEnablerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablersOnDate
Description	Gets a `DemographicEnablerList` that are effective for the entire given date range inclusive but not confined to the date range for any agent. In plenary mode, the returned list contains all known demographic enablers or an error results. Otherwise, the returned list may contain only those demographic enablers that are accessible through this session. In active mode, demographic enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive demographic enablers are returned.
Parameters	`osid.calendaring.DateTime`	`from`	a start date
Parameters	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.resource.demographic.DemographicEnablerList`		the returned `DemographicEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablersOnDateWithAgent
Description	Gets a `DemographicEnablerList` that are effective for the entire given date range inclusive but not confined to the date range and evaluated against the given agent. In plenary mode, the returned list contains all known demographic enablers or an error results. Otherwise, the returned list may contain only those demographic enablers that are accessible through this session. In active mode, demographic enablers are returned that are currently active in addition to being effective during the given date range. In any status mode, active and inactive demographic enablers are returned.
Parameters	`osid.id.Id`	`agentId`	an agent `Id`
	`osid.calendaring.DateTime`	`from`	a start date
	`osid.calendaring.DateTime`	`to`	an end date
Return	`osid.resource.demographic.DemographicEnablerList`		the returned `DemographicEnabler` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`agentId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicEnablers
Description	Gets all `DemographicEnablers.` In plenary mode, the returned list contains all known demographic enablers or an error results. Otherwise, the returned list may contain only those demographic enablers that are accessible through this session. In active mode, authorization enablers are returned that are currently active. In any status mode, active and inactive authorization enablers are returned.
Return	`osid.resource.demographic.DemographicEnablerList`		the returned `DemographicEnabler` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.