OSID - osid.offering.OfferingLookupSession Service Interface Definition

Interface	osid.offering.OfferingLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving offerings. 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 catalogue view: All offering methods in this session operate, retrieve and pertain to offerings defined explicitly in the current catalogue. Using an isolated view is useful for managing offerings with the `OfferingAdminSession.` federated catalogue view: All offering lookup methods in this session operate, retrieve and pertain to all offerings defined in this catalogue and any other catalogues implicitly available in this catalogue through catalogue inheritence. effective offering view: All offering lookup methods return offerings where the current date falls in between the effective dates inclusive. any status offering view: Offerings of any effective date are returned from methods. The methods `useFederatedCatalogueView()` and `useIsolatedCatalogueView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getCatalogueId
Description	Gets the `Catalogue` `Id` associated with this session.
Return	`osid.id.Id`		the `Catalogue Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCatalogue
Description	Gets the `Catalogue` associated with this session.
Return	`osid.offering.Catalogue`		the catalogue
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupOfferings
Description	Tests if this user can examine this catalogue. 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 these operations.
Return	`boolean`		`false` if catalogue reading methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeOfferingView
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	usePlenaryOfferingView
Description	A complete view of the `Offering` 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	useFederatedCatalogueView
Description	Federates the view for methods in this session. A federated view will include offerings in catalogues which are children of this catalogue in the catalogue hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCatalogueView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveOfferingView
Description	Only offerings whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveOfferingView
Description	All offerings of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getOffering
Description	Gets the `Offering` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Offering` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Offering` and retained for compatibility. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`offeringId`	the `Id` of the `Offering` to retrieve
Return	`osid.offering.Offering`		the returned `Offering`
Errors	NOT_FOUND		no `Offering` found with the given `Id`
	NULL_ARGUMENT		`offeringId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByIds
Description	Gets an `OfferingList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the offerings 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 offerings may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.IdList`	`offeringIds`	the list of `Ids` to retrieve
Return	`osid.offering.OfferingList`		the returned `Offering list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`offeringIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByGenusType
Description	Gets an `OfferingList` corresponding to the given offering genus `Type` which does not include offerings of types derived from the specified `Type.` In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.type.Type`	`offeringGenusType`	an offerings genus type
Return	`osid.offering.OfferingList`		the returned `Offering list`
Errors	NULL_ARGUMENT		`offeringGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByParentGenusType
Description	Gets an `OfferingList` corresponding to the given offering genus `Type` and include any additional offerings with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.type.Type`	`offeringGenusType`	an offering genus type
Return	`osid.offering.OfferingList`		the returned `Offering list`
Errors	NULL_ARGUMENT		`offeringGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByRecordType
Description	Gets an `OfferingList` containing the given offering record `Type.` In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.type.Type`	`offeringRecordType`	an offering record type
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	NULL_ARGUMENT		`offeringRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsOnDate
Description	Gets an `OfferingList` effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.OfferingList`		the returned `OfferingList`
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	getOfferingsByGenusTypeOnDate
Description	Gets an `OfferingList` by genus type and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.type.Type`	`offeringGenusType`	an offering genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`offeringGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsForCanonicalUnit
Description	Gets an `OfferingList` for the given canonical unit. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`canonicalUnitId`	a canonical unit `Id`
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	NULL_ARGUMENT		`canonicalUnitId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByGenusTypeForCanonicalUnit
Description	Gets an `OfferingList` by genus type for the given canonical unit. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`canonicalUnitId`	a canonical unit `Id`
Parameters	`osid.type.Type`	`offeringGenusType`	an offering genus type
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	NULL_ARGUMENT		`canonicalUnitId` or `offeringGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsForCanonicalUnitOnDate
Description	Gets an `OfferingList` for the given canonical unit and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`canonicalUnitId`	a canonical unit `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`canonicalUnitId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByGenusTypeForCanonicalUnitOnDate
Description	Gets an `OfferingList` by genus type for the given canonical unit and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`canonicalUnitId`	a canonical unit `Id`
	`osid.type.Type`	`offeringGenusType`	an offering genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`canonicalUnitId, offeringGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsForTimePeriod
Description	Gets an `OfferingList` for the given time period. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	NULL_ARGUMENT		`timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByGenusTypeForTimePeriod
Description	Gets an `OfferingList` by genus type for the given time period. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
Parameters	`osid.type.Type`	`offeringGenusType`	an offering genus type
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	NULL_ARGUMENT		`timePeriodId` or `offeringGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsForTimePeriodOnDate
Description	Gets an `OfferingList` for the given time period and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`timePeriodId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByGenusTypeForTimePeriodOnDate
Description	Gets an `OfferingList` by genus type for the given time period and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.type.Type`	`offeringGenusType`	an offering genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`timePeriodId, offeringGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsForCanonicalUnitAndTimePeriod
Description	Gets an `OfferingList` for the given canonical unit and time period. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`canonicalUnitId`	a canonical unit `Id`
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	NULL_ARGUMENT		`canonicalUnitId` or `timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByGenusTypeForCanonicalUnitAndTimePeriod
Description	Gets an `OfferingList` by genus type for the given canonical unit and time period. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`canonicalUnitId`	a canonical unit `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.type.Type`	`offeringGenusType`	an offering genus type
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	NULL_ARGUMENT		`canonicalUnitId,` `timePeriodId,` or `offeringGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsForCanonicalUnitAndTimePeriodOnDate
Description	Gets an `OfferingList` for the given canonical unit, time period, and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`canonicalUnitId`	a canonical unit `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`canonicalUnitId, timePeriodId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByGenusTypeForCanonicalUnitAndTimePeriodOnDate
Description	Gets an `OfferingList` by genus type for the given canonical, time period, and effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`osid.id.Id`	`canonicalUnitId`	a canonical unit `Id`
	`osid.id.Id`	`timePeriodId`	a time period `Id`
	`osid.type.Type`	`offeringGenusType`	an offering genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`canonicalUnitId, timePeriodId, offeringGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingsByCodeAndTimePeriod
Description	Gets an `OfferingList` by code and time period. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Parameters	`string`	`code`	a canonical unit `Id`
Parameters	`osid.id.Id`	`timePeriodId`	a time period `Id`
Return	`osid.offering.OfferingList`		the returned `OfferingList`
Errors	NULL_ARGUMENT		`code` or `timePeriodId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferings
Description	Gets all offerings. In plenary mode, the returned list contains all known offerings or an error results. Otherwise, the returned list may contain only those offerings that are accessible through this session. In effective mode, offerings are returned that are currently effective. In any effective mode, effective offerings and those currently expired are returned.
Return	`osid.offering.OfferingList`		a list of offerings
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.