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

Interface	osid.room.squatting.DeedLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Deed` objects. The `Deed` represents a relationship between an owner and a building. 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 room methods in this session operate, retrieve and pertain to deeds defined explicitly in the current campus. Using an isolated view is useful for managing deeds with the `DeedAdminSession.` federated campus view: All deed lookup methods in this session operate, retrieve and pertain to all deeds defined in this campus and any other campuses implicitly available in this campus through campus inheritence. effective deed view: All deed lookup methods return effective deeds. any effective deed view: deeds 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	canLookupDeeds
Description	Tests if this user can perform `Deed` 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	useComparativeDeedView
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	usePlenaryDeedView
Description	A complete view of the `Deed` 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 deeds 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	useEffectiveDeedView
Description	Only deeds whose effective dates are current are returned by methods in this session
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveDeedView
Description	Deeds of any effective dates are returned by all methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getDeed
Description	Gets the `Deed` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Deed` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Deed` and retained for compatibility. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`deedId`	`Id` of the `Deed`
Return	`osid.room.squatting.Deed`		the deed
Errors	NOT_FOUND		`deedId` not found
	NULL_ARGUMENT		`deedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getDeedsByIds
Description	Gets a `DeedList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the deeds 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 `Deeds` may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.IdList`	`deedIds`	the list of `Ids` to retrieve
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`deedIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsByGenusType
Description	Gets a `DeedList` corresponding to the given deed genus `Type` which does not include deeds of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.type.Type`	`deedGenusType`	a deed genus type
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	NULL_ARGUMENT		`deedGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsByParentGenusType
Description	Gets a `DeedList` corresponding to the given deed genus `Type` and include any additional deeds with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.type.Type`	`deedGenusType`	a deed genus type
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	NULL_ARGUMENT		`deedGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsByRecordType
Description	Gets a `DeedList` containing the given deed record `Type.` In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.type.Type`	`deedRecordType`	a deed record type
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	NULL_ARGUMENT		`deedRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsOnDate
Description	Gets a list of all deeds effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds 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.DeedList`		the returned `Deed` 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	getDeedsByGenusTypeOnDate
Description	Gets a list of all deeds with a genus type 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 deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.type.Type`	`deedGenusType`	a deed genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`deedGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsForBuilding
Description	Gets a `DeedList` containing the given building `.` In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	NULL_ARGUMENT		`buildingId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsByGenusTypeForBuilding
Description	Gets a `DeedList` containing the given building and genus type `.` In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
Parameters	`osid.type.Type`	`deedGenusType`	a deed genus type
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	NULL_ARGUMENT		`buildingId` or `deedGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsForBuildingOnDate
Description	Gets a list of all deeds for a building effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`buildingId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsByGenusTypeForBuildingOnDate
Description	Gets a list of all deeds for a building with a genus type 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 deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
	`osid.type.Type`	`deedGenusType`	a deed genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`buildingId, deedGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsForOwner
Description	Gets a `DeedList` containing the given owner resource. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.room.squatting.DeedList`		the returned `Deed` 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	getDeedsByGenusTypeForOwner
Description	Gets a `DeedList` containing the given owner and genus type `.` In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.type.Type`	`deedGenusType`	a deed genus type
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	NULL_ARGUMENT		`resourceId` or `deedGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsForOwnerOnDate
Description	Gets a list of all deeds for an owner resource effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds 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.DeedList`		the returned `Deed` 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	getDeedsByGenusTypeForOwnerOnDate
Description	Gets a list of all deeds for a resource owner with a genus type 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 deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`deedGenusType`	a deed genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, deedGenusType, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsForBuildingAndOwner
Description	Gets a `DeedList` for the given building and owner. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	NULL_ARGUMENT		`buildingId` or `resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsByGenusTypeForBuildingAndOwner
Description	Gets a `DeedList` for the given buildin, owner, and genus type `.` In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`deedGenusType`	a deed genus type
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	NULL_ARGUMENT		`buildingId, resourceId,` or `deedGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsForBuildingAndOwnerOnDate
Description	Gets a list of all deeds for a building and owner resource effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `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.DeedList`		the returned `Deed` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`buildingId, resourceId, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeedsByGenusTypeForBuildingAndOwnerOnDate
Description	Gets a list of all deeds for a building and owner with a genus type 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 deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Parameters	`osid.id.Id`	`buildingId`	a building `Id`
	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.type.Type`	`deedGenusType`	a deed genus type
	`osid.calendaring.DateTime`	`from`	start of date range
	`osid.calendaring.DateTime`	`to`	end of date range
Return	`osid.room.squatting.DeedList`		the returned `Deed` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`buildingId, resourceId, deedGenusType, from,` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDeeds
Description	Gets all `Deeds.` In plenary mode, the returned list contains all known deeds or an error results. Otherwise, the returned list may contain only those deeds that are accessible through this session. In effective mode, deeds are returned that are currently effective. In any effective mode, effective deeds and those currently expired are returned.
Return	`osid.room.squatting.DeedList`		a list of `Deeds`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.