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

Interface	osid.resource.demographic.DemographicLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Demographics.` 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 methods in this session operate, retrieve and pertain to demographic defined explicitly in the current bin. Using an isolated view is useful for managing `Demographics` with the `DemographicAdminSession.` federated bin view: All demographic methods in this session operate, retrieve and pertain to all demographic defined in this bin and any other demographic implicitly available in this bin through bin inheritence. active demographic view: All demographic lookup methods return active demographics. any status demographic view: Demographics 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	canLookupDemographics
Description	Tests if this user can perform `Demographics` 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	useComparativeDemographicView
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	usePlenaryDemographicView
Description	A complete view of the `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 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	useActiveDemographicView
Description	Only active demographics are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusDemographicView
Description	All active and inactive demographics are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getDemographic
Description	Gets the `Demographic` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Demographic` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Demographic` and retained for compatibility. In active mode, demographic are returned that are currently active. In any status mode, active and inactive demographic are returned.
Parameters	`osid.id.Id`	`demographicId`	`Id` of the `Demographic`
Return	`osid.resource.demographic.Demographic`		the demographic
Errors	NOT_FOUND		`demographicId` not found
	NULL_ARGUMENT		`demographicId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getDemographicsByIds
Description	Gets a `DemographicList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the demographic 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 `Demographics` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, demographic are returned that are currently active. In any status mode, active and inactive demographic are returned.
Parameters	`osid.id.IdList`	`demographicIds`	the list of `Ids` to retrieve
Return	`osid.resource.demographic.DemographicList`		the returned `Demographic` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`demographicIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicsByGenusType
Description	Gets a `DemographicList` corresponding to the given demographic genus `Type` which does not include demographic of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known demographic or an error results. Otherwise, the returned list may contain only those demographic that are accessible through this session. In active mode, demographic are returned that are currently active. In any status mode, active and inactive demographic are returned.
Parameters	`osid.type.Type`	`demographicGenusType`	a demographic genus type
Return	`osid.resource.demographic.DemographicList`		the returned `Demographic` list
Errors	NULL_ARGUMENT		`demographicGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicsByParentGenusType
Description	Gets a `DemographicList` corresponding to the given demographic genus `Type` and include any additional demographic with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known demographic or an error results. Otherwise, the returned list may contain only those demographic that are accessible through this session. In active mode, demographic are returned that are currently active. In any status mode, active and inactive demographic are returned.
Parameters	`osid.type.Type`	`demographicGenusType`	a demographic genus type
Return	`osid.resource.demographic.DemographicList`		the returned `Demographic` list
Errors	NULL_ARGUMENT		`demographicGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographicsByRecordType
Description	Gets a `DemographicList` containing the given demographic record `Type.` In plenary mode, the returned list contains all known demographic or an error results. Otherwise, the returned list may contain only those demographic that are accessible through this session. In active mode, demographic are returned that are currently active. In any status mode, active and inactive demographic are returned.
Parameters	`osid.type.Type`	`demographicRecordType`	a demographic record type
Return	`osid.resource.demographic.DemographicList`		the returned `Demographic` list
Errors	NULL_ARGUMENT		`demographicRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDemographics
Description	Gets all `Demographics.` In plenary mode, the returned list contains all known demographic or an error results. Otherwise, the returned list may contain only those demographic that are accessible through this session. In active mode, demographic are returned that are currently active. In any status mode, active and inactive demographic are returned.
Return	`osid.resource.demographic.DemographicList`		the returned `Demographic` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.