OSID Logo
OSID Specifications
room squatting package
Version 3.1.0
Interfaceosid.room.squatting.Lease
Implementsosid.OsidRelationship
Used Byosid.room.squatting.LeaseAdminSession
osid.room.squatting.LeaseList
osid.room.squatting.LeaseLookupSession
Description

A Lease relates a tenant to a Roo m.

MethodgetRoomId
Description

Gets the Id of the room.

Returnosid.id.Id the room Id
Compliancemandatory This method must be implemented.
MethodgetRoom
Description

Gets the room.

Returnosid.room.Room the room
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetTenantId
Description

Gets the Id of the tenant resource.

Returnosid.id.Id the tenant Id
Compliancemandatory This method must be implemented.
MethodgetTenant
Description

Gets the tenant resource.

Returnosid.resource.Resource the resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This 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.TypeleaseRecordType the type of lease record to retrieve
Returnosid.room.squatting.records.LeaseRecord the lease record
ErrorsNULL_ARGUMENT leaseRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(leaseRecordType) is false
Compliancemandatory This method must be implemented.