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

Interface	osid.room.squatting.RoomSquattingManager
Implements	`osid.OsidManager`
Implements	`osid.room.squatting.RoomSquattingProfile`
Description	The room squatting manager provides access to room squatting sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are: `LeaseLookupSession:` a session to retrieve leasees `LeaseQuerySession:` a session to query leasees `LeaseSearchSession:` a session to search for leasees `LeaseAdminSession:` a session to create, update and delete leasees `LeaseNotificationSession:` a session to receive notifications for changes in leasees `LeaseCampusSession:` a session to look up lease campus mappings `LeaseCampusAssignmentSession:` a session to manage lease campus mappings `LeaseSmartCampusSession:` a session to manage smart campuses of leasees `DeedLookupSession:` a session to retrieve deeds `DeedQuerySession:` a session to query deeds `DeedSearchSession:` a session to search for deeds `DeedAdminSession:` a session to create, update and delete deeds `DeedNotificationSession:` a session to receive notifications for changes in deeds `DeedCampusSession:` a session to look up deed campus mappings `DeedCampusAssignmentSession:` a session to manage deed campus mappings `DeedSmartCampusSession:` a session to manage smart campuses of deeds The room squatting manager also provides a profile for determing the supported search types supported by this service.
Method	getLeaseLookupSession
Description	Gets the `OsidSession` associated with the lease lookup service.
Return	`osid.room.squatting.LeaseLookupSession`		a `LeaseLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLeaseLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseLookup()` is `true.`
Method	getLeaseLookupSessionForCampus
Description	Gets the `OsidSession` associated with the lease lookup service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Lease`
Return	`osid.room.squatting.LeaseLookupSession`		a `LeaseLookupSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLeaseLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseLookup()` and `supportsVisibleFederation()` are `true`
Method	getLeaseQuerySession
Description	Gets the `OsidSession` associated with the lease query service.
Return	`osid.room.squatting.LeaseQuerySession`		a `LeaseQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLeaseQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseQuery()` is `true.`
Method	getLeaseQuerySessionForCampus
Description	Gets the `OsidSession` associated with the lease query service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Lease`
Return	`osid.room.squatting.LeaseQuerySession`		a `LeaseQuerySession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLeaseQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseQuery()` and `supportsVisibleFederation()` are `true`
Method	getLeaseSearchSession
Description	Gets the `OsidSession` associated with the lease search service.
Return	`osid.room.squatting.LeaseSearchSession`		a `LeaseSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLeaseSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseSearch()` is `true.`
Method	getLeaseSearchSessionForCampus
Description	Gets the `OsidSession` associated with the lease search service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Lease`
Return	`osid.room.squatting.LeaseSearchSession`		a `LeaseSearchSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLeaseSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseSearch()` and `supportsVisibleFederation()` are `true`
Method	getLeaseAdminSession
Description	Gets the `OsidSession` associated with the lease administrative service.
Return	`osid.room.squatting.LeaseAdminSession`		a `LeaseAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLeaseAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseAdmin()` is `true.`
Method	getLeaseAdminSessionForCampus
Description	Gets the `OsidSession` associated with the lease administrative service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Lease`
Return	`osid.room.squatting.LeaseAdminSession`		a `LeaseAdminSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLeaseAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseAdmin()` and `supportsVisibleFederation()` are `true`
Method	getLeaseNotificationSession
Description	Gets the `OsidSession` associated with the lease notification service.
Parameters	`osid.room.squatting.LeaseReceiver`	`leaseReceiver`	the receiver
Return	`osid.room.squatting.LeaseNotificationSession`		a `LeaseNotificationSession`
Errors	NULL_ARGUMENT		`leaseReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLeaseNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseNotification()` is `true.`
Method	getLeaseNotificationSessionForCampus
Description	Gets the `OsidSession` associated with the lease notification service for the given campus.
Parameters	`osid.room.squatting.LeaseReceiver`	`leaseReceiver`	the receiver
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Campus`
Return	`osid.room.squatting.LeaseNotificationSession`		a `LeaseNotificationSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`leaseReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLeaseNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseNotification()` and `supportsVisibleFederation()` are `true`
Method	getLeaseCampusSession
Description	Gets the session for retrieving lease to campus mappings.
Return	`osid.room.squatting.LeaseCampusSession`		a `LeaseCampusSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLeaseCampus()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseCampus()` is `true.`
Method	getLeaseCampusAssignmentSession
Description	Gets the session for assigning lease to campus mappings.
Return	`osid.room.squatting.LeaseCampusAssignmentSession`		a `LeaseCampusAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsLeaseCampusAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseCampusAssignment()` is `true.`
Method	getLeaseSmartCampusSession
Description	Gets the session associated with the lease smart campus for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the campus
Return	`osid.room.squatting.LeaseSmartCampusSession`		a `LeaseSmartCampusSession`
Errors	NOT_FOUND		`campusId` not found
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsLeaseSmartCampus()` is `false`
Compliance	`optional`		This method must be implemented if `supportsLeaseSmartCampus()` is `true.`
Method	getDeedLookupSession
Description	Gets the `OsidSession` associated with the deed lookup service.
Return	`osid.room.squatting.DeedLookupSession`		a `DeedLookupSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDeedLookup()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedLookup()` is `true.`
Method	getDeedLookupSessionForCampus
Description	Gets the `OsidSession` associated with the deed lookup service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Deed`
Return	`osid.room.squatting.DeedLookupSession`		a `DeedLookupSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDeedLookup()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedLookup()` and `supportsVisibleFederation()` are `true`
Method	getDeedQuerySession
Description	Gets the `OsidSession` associated with the deed query service.
Return	`osid.room.squatting.DeedQuerySession`		a `DeedQuerySession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDeedQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedQuery()` is `true.`
Method	getDeedQuerySessionForCampus
Description	Gets the `OsidSession` associated with the deed query service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Deed`
Return	`osid.room.squatting.DeedQuerySession`		a `DeedQuerySession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDeedQuery()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedQuery()` and `supportsVisibleFederation()` are `true`
Method	getDeedSearchSession
Description	Gets the `OsidSession` associated with the deed search service.
Return	`osid.room.squatting.DeedSearchSession`		a `DeedSearchSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDeedSearch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedSearch()` is `true.`
Method	getDeedSearchSessionForCampus
Description	Gets the `OsidSession` associated with the deed search service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Deed`
Return	`osid.room.squatting.DeedSearchSession`		a `DeedSearchSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDeedSearch()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedSearch()` and `supportsVisibleFederation()` are `true`
Method	getDeedAdminSession
Description	Gets the `OsidSession` associated with the deed administrative service.
Return	`osid.room.squatting.DeedAdminSession`		a `DeedAdminSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDeedAdmin()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedAdmin()` is `true.`
Method	getDeedAdminSessionForCampus
Description	Gets the `OsidSession` associated with the deed administrative service for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Deed`
Return	`osid.room.squatting.DeedAdminSession`		a `DeedAdminSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDeedAdmin()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedAdmin()` and `supportsVisibleFederation()` are `true`
Method	getDeedNotificationSession
Description	Gets the `OsidSession` associated with the deed notification service.
Parameters	`osid.room.squatting.DeedReceiver`	`DeedReceiver`	the receiver
Return	`osid.room.squatting.DeedNotificationSession`		a `DeedNotificationSession`
Errors	NULL_ARGUMENT		`DeedReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDeedNotification()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedNotification()` is `true.`
Method	getDeedNotificationSessionForCampus
Description	Gets the `OsidSession` associated with the deed notification service for the given campus.
Parameters	`osid.room.squatting.DeedReceiver`	`DeedReceiver`	the receiver
Parameters	`osid.id.Id`	`campusId`	the `Id` of the `Campus`
Return	`osid.room.squatting.DeedNotificationSession`		a `DeedNotificationSession`
Errors	NOT_FOUND		no `Campus` found by the given `Id`
	NULL_ARGUMENT		`DeedReceiver` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDeedNotification()` or `supportsVisibleFederation()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedNotification()` and `supportsVisibleFederation()` are `true`
Method	getDeedCampusSession
Description	Gets the session for retrieving deed to campus mappings.
Return	`osid.room.squatting.DeedCampusSession`		a `DeedCampusSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDeedCampus()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedCampus()` is `true.`
Method	getDeedCampusAssignmentSession
Description	Gets the session for assigning deed to campus mappings.
Return	`osid.room.squatting.DeedCampusAssignmentSession`		a `DeedCampusAssignmentSession`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsDeedCampusAssignment()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedCampusAssignment()` is `true.`
Method	getDeedSmartCampusSession
Description	Gets the session associated with the deed smart campus for the given campus.
Parameters	`osid.id.Id`	`campusId`	the `Id` of the campus
Return	`osid.room.squatting.DeedSmartCampusSession`		a `DeedSmartCampusSession`
Errors	NOT_FOUND		`campusId` not found
	NULL_ARGUMENT		`campusId` is `null`
	OPERATION_FAILED		unable to complete request
	UNIMPLEMENTED		`supportsDeedSmartCampus()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDeedSmartCampus()` is `true.`
Method	getRoomSquattingBatchManager
Description	Gets a `RoomSquattingBatchManager.`
Return	`osid.room.squatting.batch.RoomSquattingBatchManager`		a `RoomSquattingBatchManager`
Errors	OPERATION_FAILED		unable to complete request
Errors	UNIMPLEMENTED		`supportsRoomSquattingBatch()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRoomSquattingBatch()` is `true.`