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

Interface	osid.room.squatting.RoomSquattingProfile
Implements	`osid.OsidProfile`
Description	The room squatting profile describes the interoperability among room squatting services.
Method	supportsVisibleFederation
Description	Tests if any deed federation is exposed. Federation is exposed when a specific deed may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of deeds appears as a single deed.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLeaseLookup
Description	Tests for the availability of an lease lookup service.
Return	`boolean`		`true` if lease lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLeaseQuery
Description	Tests if querying leasees is available.
Return	`boolean`		`true` if lease query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLeaseSearch
Description	Tests if searching for leasees is available.
Return	`boolean`		`true` if lease search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLeaseAdmin
Description	Tests for the availability of a lease administrative service for creating and deleting leasees.
Return	`boolean`		`true` if lease administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLeaseNotification
Description	Tests for the availability of a lease notification service.
Return	`boolean`		`true` if lease notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsLeaseCampus
Description	Tests if a lease to campus lookup session is available.
Return	`boolean`		`true` if lease campus lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLeaseCampusAssignment
Description	Tests if a lease to campus assignment session is available.
Return	`boolean`		`true` if lease campus assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLeaseSmartCampus
Description	Tests if a lease smart campus session is available.
Return	`boolean`		`true` if lease smart campus is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeedLookup
Description	Tests for the availability of an deed lookup service.
Return	`boolean`		`true` if deed lookup is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeedQuery
Description	Tests if querying deeds is available.
Return	`boolean`		`true` if deed query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeedSearch
Description	Tests if searching for deeds is available.
Return	`boolean`		`true` if deed search is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeedAdmin
Description	Tests for the availability of a deed administrative service for creating and deleting deeds.
Return	`boolean`		`true` if deed administration is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeedNotification
Description	Tests for the availability of a deed notification service.
Return	`boolean`		`true` if deed notification is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsDeedCampus
Description	Tests if a deed to campus lookup session is available.
Return	`boolean`		`true` if deed campus lookup session is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeedCampusAssignment
Description	Tests if a deed to campus assignment session is available.
Return	`boolean`		`true` if deed campus assignment is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeedSmartCampus
Description	Tests if a deed smart campus session is available.
Return	`boolean`		`true` if deed smart campus is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsRoomSquattingBatch
Description	Tests if a service to manage squatters in bulk is available.
Return	`boolean`		`true` if a room batch squatting service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLeaseRecordTypes
Description	Gets the supported `Lease` record types.
Return	`osid.type.TypeList`		a list containing the supported lease record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsLeaseRecordType
Description	Tests if the given `Lease` record type is supported.
Parameters	`osid.type.Type`	`leaseRecordType`	a `Type` indicating a `Lease` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`leaseRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLeaseSearchRecordTypes
Description	Gets the supported lease search record types.
Return	`osid.type.TypeList`		a list containing the supported lease search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsLeaseSearchRecordType
Description	Tests if the given lease search record type is supported.
Parameters	`osid.type.Type`	`leaseSearchRecordType`	a `Type` indicating a lease record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`leaseSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDeedRecordTypes
Description	Gets the supported `Deed` record types.
Return	`osid.type.TypeList`		a list containing the supported deed record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeedRecordType
Description	Tests if the given `Deed` record type is supported.
Parameters	`osid.type.Type`	`deedRecordType`	a `Type` indicating a `Deed` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`deedRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getDeedSearchRecordTypes
Description	Gets the supported deed search record types.
Return	`osid.type.TypeList`		a list containing the supported deed search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsDeedSearchRecordType
Description	Tests if the given deed search record type is supported.
Parameters	`osid.type.Type`	`deedSearchRecordType`	a `Type` indicating a deed record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`deedSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.