OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.Lease
Implementsosid.OsidRelationship
Description

A Lease represents a collection of rooms with a Deed.

MethodgetRoomId
Description

Gets the Id of the room.

Returnosid.id.Idthe room Id
CompliancemandatoryThis method must be implemented.
MethodgetRoom
Description

Gets the room.

Returnosid.room.Roomthe room
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetTenantId
Description

Gets the Id of the tenant resource.

Returnosid.id.Idthe tenant Id
CompliancemandatoryThis method must be implemented.
MethodgetTenant
Description

Gets the tenant resource.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetLeaseRecord
Description

Gets the lease record corresponding to the given Lease record Type. This method is used to retrieve an object implementing the requested record. The leaseRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(leaseRecordType) is true .

Parametersosid.type.TypeleaseRecordTypethe type of lease record to retrieve
Returnosid.room.squatting.records.LeaseRecordthe lease record
ErrorsNULL_ARGUMENT leaseRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(leaseRecordType) is false
CompliancemandatoryThis method must be implemented.