OSID - osid.room.squatting.LeaseLookupSession Service Interface Definition

Interface	osid.room.squatting.LeaseLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Lease` objects. The `Lease` represents a relationship to a room. 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 campus view: All lease methods in this session operate, retrieve and pertain to leases defined explicitly in the current campus. Using an isolated view is useful for managing leases with the `LeaseAdminSession.` federated campus view: All lease lookup methods in this session operate, retrieve and pertain to all leases defined in this campus and any other campuses implicitly available in this campus through campus inheritence. effective lease view: All lease lookup methods return effective leases. any effective lease view: Leases of any effective date are returned.
Method	getCampusId
Description	Gets the `Campus` `Id` associated with this session.
Return	`osid.id.Id`		the `Campus Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCampus
Description	Gets the `Campus` associated with this session.
Return	`osid.room.Campus`		the campus
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupLeases
Description	Tests if this user can perform `Lease` 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	useComparativeLeaseView
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	usePlenaryLeaseView
Description	A complete view of the `Lease` 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	useFederatedCampusView
Description	Federates the view for methods in this session. A federated view will include leases in campuses which are children of this campus in the campus hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedCampusView
Description	Isolates the view for methods in this session. An isolated view restricts retrievals to this campus only.
Compliance	`mandatory`		This method is must be implemented.
Method	useEffectiveLeaseView
Description	Only leases whose effective dates are current are returned by methods in this session
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveLeaseView
Description	Leases of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getLease
Description	Gets the `Lease` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Lease` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Lease` and retained for compatibility. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`leaseId`	`Id` of the `Lease`
Return	`osid.room.squatting.Lease`		the lease
Errors	NOT_FOUND		`leaseId` not found
	NULL_ARGUMENT		`leaseId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getLeasesByIds
Description	Gets a `LeaseList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the leases 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 `Leases` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.IdList`	`leaseIds`	the list of `Ids` to retrieve
Return	`osid.room.squatting.LeaseList`		the returned `Lease` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`leaseIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesByGenusType
Description	Gets a `LeaseList` corresponding to the given lease genus `Type` which does not include leases of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.type.Type`	`leaseGenusType`	a lease genus type
Return	`osid.room.squatting.LeaseList`		the returned `Lease` list
Errors	NULL_ARGUMENT		`leaseGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesByParentGenusType
Description	Gets a `LeaseList` corresponding to the given lease genus `Type` and include any additional leases with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.type.Type`	`leaseGenusType`	a lease genus type
Return	`osid.room.squatting.LeaseList`		the returned `Lease` list
Errors	NULL_ARGUMENT		`leaseGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesByRecordType
Description	Gets a `LeaseList` containing the given lease record `Type.` In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.type.Type`	`leaseRecordType`	a lease record type
Return	`osid.room.squatting.LeaseList`		the returned `Lease` list
Errors	NULL_ARGUMENT		`leaseRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesOnDate
Description	Gets a list of all leases effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases 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.room.squatting.LeaseList`		the returned `LeaseList`
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	getLeasesByGenusTypeOnDate
Description	Gets a list of all leases of a genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.type.Type`	`leaseGenusType`	a lease genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`leaseGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesForRoom
Description	Gets a list of all leases corresponding to a room `Id.` In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`roomId`	the `Id` of the room
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	NULL_ARGUMENT		`roomId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesByGenusTypeForRoom
Description	Gets a list of all leases for a room and a lease genus type `.` In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`roomId`	a room `Id`
Parameters	`osid.type.Type`	`leaseGenusType`	a lease genus type
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`roomId` or `leaseGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesForRoomOnDate
Description	Gets a list of all leases for a room effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`roomId`	a room `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`roomId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesByGenusTypeForRoomOnDate
Description	Gets a list of all leases for a room and of a lease genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`roomId`	a room `Id`
	`osid.type.Type`	`leaseGenusType`	a lease genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`roomId, leaseGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesForTenant
Description	Gets a list of all leases for a tenant corresponding to a room `Id.` In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesByGenusTypeForTenant
Description	Gets a list of all leases corresponding to a tenant `Id` and of a lease genus type. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resourceId `Id`
Parameters	`osid.type.Type`	`leaseGenusType`	a lease genus type
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`resourceId` or `leaseGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesForTenantOnDate
Description	Gets a list of all leases for a tenant effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases 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.room.squatting.LeaseList`		the returned `LeaseList`
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	getLeasesByGenusTypeForTenantOnDate
Description	Gets a list of all leases for a tenant and of a lease genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`leaseGenusType`	a lease genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, leaseGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesForRoomAndTenant
Description	Gets a list of all leases corresponding to a room and tenant. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`roomId`	the `Id` of the room
Parameters	`osid.id.Id`	`resourceId`	a tenant `Id`
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	NULL_ARGUMENT		`roomId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesByGenusTypeForRoomAndTenant
Description	Gets a list of all leases for a room, resource, and of a lease genus type. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`roomId`	a room `Id`
	`osid.id.Id`	`resourceId`	a tenant `Id`
	`osid.type.Type`	`leaseGenusType`	a lease genus type
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	INVALID_ARGUMENT		`to` is less than `from`
	NULL_ARGUMENT		`roomId, resourceId,` or `leaseGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesForRoomAndTenantOnDate
Description	Gets a list of all leases for a room and tenant effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`roomId`	a room `Id`
	`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.room.squatting.LeaseList`		the returned `LeaseList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`roomId, resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeasesByGenusTypeForRoomAndTenantOnDate
Description	Gets a list of all leases for a room, tenant, and of a lease genus type effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Parameters	`osid.id.Id`	`roomId`	a room `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`leaseGenusType`	a lease genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.LeaseList`		the returned `LeaseList`
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`roomId, resourceId, leaseGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getLeases
Description	Gets all `Leases.` In plenary mode, the returned list contains all known leases or an error results. Otherwise, the returned list may contain only those leases that are accessible through this session. In effective mode, leases are returned that are currently effective. In any effective mode, effective leases and those currently expired are returned.
Return	`osid.room.squatting.LeaseList`		a list of `Leases`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.