OSID - osid.offering.rules.OfferingConstrainerLookupSession Service Interface Definition

Interface	osid.offering.rules.OfferingConstrainerLookupSession
Implements	`osid.OsidSession`
Used By	`osid.offering.rules.OfferingRulesManager`
Used By	`osid.offering.rules.OfferingRulesProxyManager`
Description	This session provides methods for retrieving `OfferingConstrainers`. 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 catalogue view: All offering constrainer methods in this session operate, retrieve and pertain to offering constrainer defined explicitly in the current catalogue. Using an isolated view is useful for managing `OfferingConstrainers` with the `OfferingConstrainerAdminSession`. federated catalogue view: All offering constrainer methods in this session operate, retrieve and pertain to all offering constrainer defined in this catalogue and any other offering constrainer implicitly available in this catalogue through catalogue inheritence. active offering constrainer view: All offering constrainer lookup methods return active offering constrainers. any status offering constrainer view: CanonicalUnit constrainers 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	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	canLookupOfferingConstrainers
Description	Tests if this user can perform `OfferingConstrainers` 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	useComparativeOfferingConstrainerView
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	usePlenaryOfferingConstrainerView
Description	A complete view of the `OfferingConstrainer` 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 offering constrainer 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 lookups to this catalogue only.
Compliance	`mandatory`		This method is must be implemented.
Method	useActiveOfferingConstrainerView
Description	Only active offering constrainers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusOfferingConstrainerView
Description	All active and inactive offering constrainers are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getOfferingConstrainer
Description	Gets the `OfferingConstrainer` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `OfferingConstrainer` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `OfferingConstrainer` and retained for compatibility. In active mode, offering constrainers are returned that are currently active. In any status mode, active and inactive offering constrainers are returned.
Parameters	`osid.id.Id`	`offeringConstrainerId`	`Id` of the `OfferingConstrainer`
Return	`osid.offering.rules.OfferingConstrainer`		the offering constrainer
Errors	NOT_FOUND		`offeringConstrainerId` not found
	NULL_ARGUMENT		`offeringConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getOfferingConstrainersByIds
Description	Gets an `OfferingConstrainerList` corresponding to the given `IdList`. In plenary mode, the returned list contains all of the offering constrainer 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 `OfferingConstrainers` may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, offering constrainers are returned that are currently active. In any status mode, active and inactive offering constrainers are returned.
Parameters	`osid.id.IdList`	`offeringConstrainerIds`	the list of `Ids` to retrieve
Return	`osid.offering.rules.OfferingConstrainerList`		the returned `OfferingConstrainer` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`offeringConstrainerIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainersByGenusType
Description	Gets an `OfferingConstrainerList` corresponding to the given offering constrainer genus `Type` which does not include offering constrainer of genus types derived from the specified `Type`. In plenary mode, the returned list contains all known offering constrainer or an error results. Otherwise, the returned list may contain only those offering constrainer that are accessible through this session. In active mode, offering constrainers are returned that are currently active. In any status mode, active and inactive offering constrainers are returned.
Parameters	`osid.type.Type`	`offeringConstrainerGenusType`	an offering constrainer genus type
Return	`osid.offering.rules.OfferingConstrainerList`		the returned `OfferingConstrainer` list
Errors	NULL_ARGUMENT		`offeringConstrainerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainersByParentGenusType
Description	Gets an `OfferingConstrainerList` corresponding to the given offering constrainer genus `Type` and include any additional offering constrainer with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known offering constrainer or an error results. Otherwise, the returned list may contain only those offering constrainer that are accessible through this session. In active mode, offering constrainers are returned that are currently active. In any status mode, active and inactive offering constrainers are returned.
Parameters	`osid.type.Type`	`offeringConstrainerGenusType`	an offering constrainer genus type
Return	`osid.offering.rules.OfferingConstrainerList`		the returned `OfferingConstrainer` list
Errors	NULL_ARGUMENT		`offeringConstrainerGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainersByRecordType
Description	Gets an `OfferingConstrainerList` containing the given offering constrainer record `Type`. In plenary mode, the returned list contains all known offering constrainer or an error results. Otherwise, the returned list may contain only those offering constrainer that are accessible through this session. In active mode, offering constrainers are returned that are currently active. In any status mode, active and inactive offering constrainers are returned.
Parameters	`osid.type.Type`	`offeringConstrainerRecordType`	an offering constrainer record type
Return	`osid.offering.rules.OfferingConstrainerList`		the returned `OfferingConstrainer` list
Errors	NULL_ARGUMENT		`offeringConstrainerRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getOfferingConstrainers
Description	Gets all `OfferingConstrainers`. In plenary mode, the returned list contains all known offering constrainer or an error results. Otherwise, the returned list may contain only those offering constrainer that are accessible through this session. In active mode, offering constrainers are returned that are currently active. In any status mode, active and inactive offering constrainers are returned.
Return	`osid.offering.rules.OfferingConstrainerList`		the returned `OfferingConstrainer` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.