OSID - osid.provisioning.RequestTransactionLookupSession Service Interface Definition

Interface	osid.provisioning.RequestTransactionLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `RequestTransactions.` 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 transaction methods in this session operate, retrieve and pertain to request transactions defined explicitly in the current distributor. Using an isolated view is useful for managing `RequestTransactions` with the `RequesTransactionAdminSession.` federated distributor view: All request transaction methods in this session operate, retrieve and pertain to all request transaction defined in this distributor and any other request transaction implicitly available in this distributor through distributor inheritence. effective request view: All request transaction lookup methods return request transactions where the current date falls in between the effective dates inclusive. any effective request view: Request transactions 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	canLookupRequestTransactions
Description	Tests if this user can perform `RequestTransaction` 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	useComparativeRequestTransactionView
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	usePlenaryRequestTransactionView
Description	A complete view of the `RequestTransaction` 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 request transactions 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	useEffectiveRequestTransactionView
Description	Only request transactions whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveRequestTransactionView
Description	All request transactions of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getRequestTransaction
Description	Gets the `RequestTransaction` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `RequestTransaction` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `RequestTransaction` and retained for compatibility. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.id.Id`	`requestTransactionId`	`Id` of `RequestTransaction`
Return	`osid.provisioning.RequestTransaction`		the request transaction
Errors	NOT_FOUND		`requestTransactionId` not found
	NULL_ARGUMENT		`requestTransactionId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getRequestTransactionsByIds
Description	Gets a `RequestTransactionList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the request transaction 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 `RequestTransactions` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.id.IdList`	`requestTransactionIds`	the list of `Ids` to retrieve
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`requestTransactionIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionsByGenusType
Description	Gets a `RequestTransactionList` corresponding to the given request transaction genus `Type` which does not include of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.type.Type`	`requestTransactionGenusType`	a request transaction genus type
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` list
Errors	NULL_ARGUMENT		`requestTransactionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionsByParentGenusType
Description	Gets a `RequestTransactionList` corresponding to the given request transaction genus `Type` and include any additional request transaction with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.type.Type`	`requestTransactionGenusType`	a request transaction genus type
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` list
Errors	NULL_ARGUMENT		`requestTransactionGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionsByRecordType
Description	Gets a `RequestTransactionList` containing the given request transaction record `Type.` In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.type.Type`	`requestTransactionRecordType`	a request transaction record type
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` list
Errors	NULL_ARGUMENT		`requestTransactionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionsByRequest
Description	Gets a list of request transactions by request. In plenary mode, the returned list contains all known request transaction or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.id.Id`	`requestId`	a request `Id`
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` list
Errors	NULL_ARGUMENT		`requestId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionsOnDate
Description	Gets a list of request transactions effective beginning in the date range. Request transaction are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known request transaction or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective request transactions 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.RequestTransactionList`		the returned `RequestTransaction` 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	getRequestTransactionsForSubmitter
Description	Gets a list of request transactions for a submitter in the request transaction. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` 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	getRequestTransactionsForSubmitterOnDate
Description	Gets a list of request transactions for a submitter and effective beginning in the date range. Request transactions are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective request transactions 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.RequestTransactionList`		the returned `RequestTransaction` 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	getRequestTransactionsForBroker
Description	Gets a list of request transactions for a bropker. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.id.Id`	`brokerId`	a broker `Id`
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` list
Errors	NULL_ARGUMENT		`brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionsForBrokerOnDate
Description	Gets a list of request transactions for a broker and effective beginning in the date range. Request transactions are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.id.Id`	`brokerId`	a broker `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`brokerId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionsForSubmitterAndBroker
Description	Gets a list of request transactions for a submitter and broker. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`brokerId`	a broker `Id`
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` list
Errors	NULL_ARGUMENT		`resourceId` or `brokerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactionsForSubmitterAndBrokerOnDate
Description	Gets a list of request transactions for a submitter and broker and effective beginning in the date range. Request transaction are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective request transactions and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`brokerId`	a broker `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.provisioning.RequestTransactionList`		the returned `RequestTransaction` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, brokerId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getRequestTransactions
Description	Gets all `RequestTransactions.` In plenary mode, the returned list contains all known request transactions or an error results. Otherwise, the returned list may contain only those request transactions that are accessible through this session. In effective mode, request transactions are returned that are currently effective. In any effective mode, effective request transactions and those currently expired are returned.
Return	`osid.provisioning.RequestTransactionList`		a list of `RequestTransaction`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.