OSID - osid.provisioning.RequestLookupSession Service Interface Definition

Interface	osid.provisioning.RequestLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Request` relationships. 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 distributor view: All request methods in this session operate, retrieve and pertain to requests defined explicitly in the current distributor. Using an isolated view is useful for managing `Requests` with the `RequestAdminSession.` federated distributor view: All request methods in this session operate, retrieve and pertain to all requests defined in this distributor and any other requests implicitly available in this distributor through distributor inheritence. effective request view: All request lookup methods return requests where the current date falls in between the effective dates inclusive. any effective request view: Requests of any effective date 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 any lookup methods.
Method	getDistributorId
Description	Gets the `Distributor` `Id` associated with this session.
Return	`osid.id.Id`		the `Distributor Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDistributor
Description	Gets the `Distributor` associated with this session.
Return	`osid.provisioning.Distributor`		the distributor
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupRequests
Description	Tests if this user can perform `Request` 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	useComparativeRequestView
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	usePlenaryRequestView
Description	A complete view of the `Request` 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	useFederatedDistributorView
Description	Federates the view for methods in this session. A federated view will include requests in distributors which are children of this distributor in the distributor hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedDistributorView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this distributor only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveRequestView
Description	Only requests whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveRequestView
Description	All requests of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getRequest
Description	Gets the `Request` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Request` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Request` and retained for compatibility. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.id.Id`	`requestId`	`Id` of the `Request`
Return	`osid.provisioning.Request`		the request
Errors	NOT_FOUND		`requestId` not found
	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRequestsByIds
Description	Gets a `RequestList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the requests 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 `Requests` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.id.IdList`	`requestIds`	the list of `Ids` to retrieve
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`requestIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsByGenusType
Description	Gets a `RequestList` corresponding to the given request genus `Type` which does not include requests of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.type.Type`	`requestGenusType`	a request genus type
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	NULL_ARGUMENT		`requestGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsByParentGenusType
Description	Gets a `RequestList` corresponding to the given request genus `Type` and include any additional requests with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.type.Type`	`requestGenusType`	a request genus type
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	NULL_ARGUMENT		`requestGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsByRecordType
Description	Gets a `RequestList` containing the given request record `Type.` In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.type.Type`	`requestRecordType`	a request record type
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	NULL_ARGUMENT		`requestRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsOnDate
Description	Gets a list of requests effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective requests 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.provisioning.RequestList`		the returned `Request` 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	getRequestsForRequester
Description	Gets a list of requests for a requester. In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsForRequesterOnDate
Description	Gets a list of requests for a requester 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 requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsForQueue
Description	Gets a list of requests for a queue. In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.id.Id`	`queueId`	a queue `Id`
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	NULL_ARGUMENT		`queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsForQueueOnDate
Description	Gets a list of requests for a queue 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 requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.id.Id`	`queueId`	a queue `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`queueId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsForRequesterAndQueue
Description	Gets a list of requests for a requester and queue. In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`queueId`	a queue `Id`
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	NULL_ARGUMENT		`resourceId` or `queueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestsForRequesterAndQueueOnDate
Description	Gets a list of requests for a requester and queue 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 requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective in addition to being effective during the given date range. In any effective mode, effective requests and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`queueId`	a queue `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.RequestList`		the returned `Request` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, queueId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequests
Description	Gets all `Requests.` In plenary mode, the returned list contains all known requests or an error results. Otherwise, the returned list may contain only those requests that are accessible through this session. In effective mode, requests are returned that are currently effective. In any effective mode, effective requests and those currently expired are returned.
Return	`osid.provisioning.RequestList`		a list of `Requests`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.