OSID - osid.course.registration.request.RegistrationRequestItemLookupSession Service Interface Definition

Interface	osid.course.registration.request.RegistrationRequestItemLookupSession
Implements	`osid.OsidSession`
Used By	`osid.course.registration.request.RegistrationRequestManager`
Used By	`osid.course.registration.request.RegistrationRequestProxyManager`
Description	This session provides methods for retrieving `RegistrationReq` uestItems. 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 course catalog view: All registration request item methods in this session operate, retrieve and pertain to registration request items defined explicitly in the current course catalog Using an isolated view is useful for managing `RegistrationRe` questItems with the `RegistrationRequestItemAdminSe` ssion. federated registration request item view: All registration request item methods in this session operate, retrieve and pertain to all registration request items defined in this course catalog and any other registration request items implicitly available in this course catalog through course catalog inheritence. 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 `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods.
Method	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalogList`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupRegistrationRequestItems
Description	Tests if this user can perform `RegistrationR` equestItem 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	useComparativeRegistrationRequestItemView
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	usePlenaryRegistrationRequestItemView
Description	A complete view of the `RegistrationRequestItem` 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	useFederatedCourseCatalogView
Description	Federates the view for methods in this session. A federated view will include registration request items in course catalogs which are children of this course catalog in the course catalog hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCourseCatalogView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	getRegistrationRequestItem
Description	Gets the `RegistrationRequestItem` specified by its `Id` . In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `RegistrationR` equestItem may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `RegistrationRe` questItem and retained for compatibility.
Parameters	`osid.id.Id`	`registrationRequestItemId`	`Id` of the `RegistrationRequestItem`
Return	`osid.course.registration.request.RegistrationRequestItem`		the registration request item
Errors	NOT_FOUND		`registrationRequestItemId` not found
	NULL_ARGUMENT		`registrationRequestItemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRegistrationRequestItemsByIds
Description	Gets a `RegistrationRequestItemList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the registration request items 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 `RegistrationReque` stItems may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`registrationRequestItemIds`	the list of `Ids` to retrieve
Return	`osid.course.registration.request.RegistrationRequestItemList`		the returned `RegistrationRequestItem` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`registrationRequestItemIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemsByGenusType
Description	Gets a `RegistrationRequestItemList` corresponding to the given registration request item genus `Type` which does not include registration request items of genus types derived from the specified `Type` . In plenary mode, the returned list contains all known registration request items or an error results. Otherwise, the returned list may contain only those registration request items that are accessible through this session.
Parameters	`osid.type.Type`	`registrationRequestItemGenusType`	a registration request item genus type
Return	`osid.course.registration.request.RegistrationRequestItemList`		the returned `RegistrationRequestItem` list
Errors	NULL_ARGUMENT		`registrationRequestItemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemsByParentGenusType
Description	Gets a `RegistrationRequestItemList` corresponding to the given registration request item genus `Type` and include any additional registration request items with genus types derived from the specified `Type` . In plenary mode, the returned list contains all known registration request items or an error results. Otherwise, the returned list may contain only those registration request items that are accessible through this session.
Parameters	`osid.type.Type`	`registrationRequestItemGenusType`	a registration request item genus type
Return	`osid.course.registration.request.RegistrationRequestItemList`		the returned `RegistrationRequestItem` list
Errors	NULL_ARGUMENT		`registrationRequestItemGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemsByRecordType
Description	Gets a `RegistrationRequestItemList` containing the given registration request item record `Type` . In plenary mode, the returned list contains all known registration request items or an error results. Otherwise, the returned list may contain only those registration request items that are accessible through this session.
Parameters	`osid.type.Type`	`registrationRequestItemRecordType`	a registration request item record type
Return	`osid.course.registration.request.RegistrationRequestItemList`		the returned `RegistrationRequestItem` list
Errors	NULL_ARGUMENT		`registrationRequestItemRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItemsForRegistrationRequest
Description	Gets a `RegistrationRequestItemList` for the given registration request. In plenary mode, the returned list contains all known registration request items or an error results. Otherwise, the returned list may contain only those registration request items that are accessible through this session.
Parameters	`osid.id.Id`	`registrationRequestId`	a registration request `Id`
Return	`osid.course.registration.request.RegistrationRequestItemList`		the returned `RegistrationRequestItem` list
Errors	NULL_ARGUMENT		`registrationRequestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRegistrationRequestItems
Description	Gets all `RegistrationRequestItems` . In plenary mode, the returned list contains all known registration request items or an errorerwise, the returned list may contain only those registration request items that are acugh this session.
Return	`osid.course.registration.request.RegistrationRequestItemList`		a list of `RegistrationRequestItems`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.