OSID - osid.resourcing.AvailabilityLookupSession Service Interface Definition

Interface	osid.resourcing.AvailabilityLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving availabilities. 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 foundry view: All availability methods in this session operate, retrieve and pertain to availabilities defined explicitly in the current foundry. Using an isolated view is useful for managing `Availabilities` with the `AvailabilityAdminSession.` federated foundry view: All availability lookup methods in this session operate, retrieve and pertain to all availabilities defined in this foundry and any other availabilities implicitly available in this foundry through foundry inheritence. effective availability view: All availability lookup methods return availabilities where the current date falls in between the effective dates inclusive. any effective availability view: Availabilities of any effective date are returned from methods. The methods `useFederatedFoundryView()` and `useIsolatedFoundryView()` behave as a radio group and one should be selected before invoking any lookup methods. Availabilities may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Availabilities.`
Method	getFoundryId
Description	Gets the `Foundry` `Id` associated with this session.
Return	`osid.id.Id`		the `Foundry Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getFoundry
Description	Gets the `Foundry` associated with this session.
Return	`osid.resourcing.Foundry`		the foundry
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupAvailabilities
Description	Tests if this user can perform `Availability` 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 not 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	useComparativeAvailabilityView
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	usePlenaryAvailabilityView
Description	A complete view of the `Availability` 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	useFederatedFoundryView
Description	Federates the view for methods in this session. A federated view will include availabilities in foundries which are children of this foundry in the foundry hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedFoundryView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this foundry only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveAvailabilityView
Description	Only availabilities whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveAvailabilityView
Description	All availabilities of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getAvailability
Description	Gets the `Availability` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Availability` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Availability` and retained for compatibility. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Parameters	`osid.id.Id`	`availabilityId`	the `Id` of the `Availability` to retrieve
Return	`osid.resourcing.Availability`		the returned `Availability`
Errors	NOT_FOUND		no `Availability` found with the given `Id`
	NULL_ARGUMENT		`availabilityId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesByIds
Description	Gets an `AvailabilityList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the availabilities 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 `Availabilities` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Parameters	`osid.id.IdList`	`availabilityIds`	the list of `Ids` to retrieve
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` list
Errors	NOT_FOUND		an `Id` was not found
	NULL_ARGUMENT		`availabilityIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesByGenusType
Description	Gets an `AvailabilityList` corresponding to the given availability genus `Type` which does not include availabilities of types derived from the specified `Type.` In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Parameters	`osid.type.Type`	`availabilityGenusType`	an availability genus type
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` list
Errors	NULL_ARGUMENT		`availabilityGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesByParentGenusType
Description	Gets an `AvailabilityList` corresponding to the given availability genus `Type` and include any additional availabilities with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Parameters	`osid.type.Type`	`availabilityGenusType`	an availability genus type
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` list
Errors	NULL_ARGUMENT		`availabilityGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesByRecordType
Description	Gets an `AvailabilityList` containing the given availability record `Type.` In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Parameters	`osid.type.Type`	`availabilityRecordType`	an availability record type
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` list
Errors	NULL_ARGUMENT		`availabilityRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesOnDate
Description	Gets a list of availabilities effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities 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.resourcing.AvailabilityList`		the returned `Availability` 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	getAvailabilitiesForResource
Description	Gets a list of availabilities for a resource. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` 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	getAvailabilitiesForResourceOnDate
Description	Gets a list of availabilities for a resource 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 availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities 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.resourcing.AvailabilityList`		the returned `Availability` 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	getAvailabilitiesForJob
Description	Gets a list of availabilities for a job. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Parameters	`osid.id.Id`	`jobId`	a job `Id`
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` list
Errors	NULL_ARGUMENT		`jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesForJobOnDate
Description	Gets a list of availabilities for a job 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 availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Parameters	`osid.id.Id`	`jobId`	a job `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`jobId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesForResourceAndJob
Description	Gets a list of availabilities for a resource and job. In plenary mode, the returned list contains all known availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, credits are returned that are currently effective. In any effective mode, effective credits and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`jobId`	a job `Id`
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` list
Errors	NULL_ARGUMENT		`resourceId` or `jobId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilitiesForResourceAndJobOnDate
Description	Gets a list of availabilities for a resource and job 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 availabilities or an error results. Otherwise, the returned list may contain only those availabilities that are accessible through this session. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`jobId`	a job `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, jobId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilities
Description	Gets all availabilities. In plenary mode, the returned list contains all of the availabilities, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Availabilities` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, availabilities are returned that are currently effective. In any effective mode, effective availabilities and those currently expired are returned.
Return	`osid.resourcing.AvailabilityList`		the returned `Availability` list
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.