OSID Logo
OSID Specifications
room squatting package
Version 3.0.0
Release Candidate Preview
Interfaceosid.room.squatting.LeaseQuery
Implementsosid.OsidRelationshipQuery
Description

This is the query for searching for leases. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

MethodmatchRoomId
Description

Sets the room Id for this query to match rooms assigned to leases.

Parametersosid.id.IdroomIda room Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT roomId is null
CompliancemandatoryThis method must be implemented.
MethodclearRoomIdTerms
Description

Clears the room Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRoomQuery
Description

Tests if a room query is available.

Returnboolean true if a room query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRoomQuery
Description

Gets the query for a lease.

Returnosid.room.RoomQuerythe room query
ErrorsUNIMPLEMENTED supportsRoomQuery() is false
ComplianceoptionalThis method must be implemented if supportsRoomQuery() is true.
MethodclearRoomTerms
Description

Clears the room terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTenantId
Description

Sets the resource Id for this query to match rooms assigned to leases.

Parametersosid.id.IdresourceIda resource Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearTenantIdTerms
Description

Clears the tenant Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsTenantQuery
Description

Tests if a tenant query is available.

Returnboolean true if a tenant query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetTenantQuery
Description

Gets the query for a tenant resource.

Returnosid.resource.ResourceQuerythe resource query
ErrorsUNIMPLEMENTED supportsTenantQuery() is false
ComplianceoptionalThis method must be implemented if supportsTenantQuery() is true.
MethodclearTenantTerms
Description

Clears the tenant terms.

CompliancemandatoryThis method must be implemented.
MethodmatchCampusId
Description

Sets the lease Id for this query to match rooms assigned to campuses.

Parametersosid.id.IdcampusIda campus Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT campusId is null
CompliancemandatoryThis method must be implemented.
MethodclearCampusIdTerms
Description

Clears the campus Id terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsCampusQuery
Description

Tests if a CampusQuery is available.

Returnboolean true if a campus query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCampusQuery
Description

Gets the query for a campus query. Multiple retrievals produce a nested OR term.

Returnosid.room.CampusQuerythe campus query
ErrorsUNIMPLEMENTED supportsCampusQuery() is false
ComplianceoptionalThis method must be implemented if supportsCampusQuery() is true.
MethodclearCampusTerms
Description

Clears the campus terms.

CompliancemandatoryThis method must be implemented.
MethodgetLeaseQueryRecord
Description

Gets the lease query record corresponding to the given Lease record Type. Multiple record retrievals produce a nested boolean OR term.

Parametersosid.type.TypeleaseRecordTypea lease record type
Returnosid.room.squatting.records.LeaseQueryRecordthe lease query record
ErrorsNULL_ARGUMENT leaseRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(leaseRecordType) is false
CompliancemandatoryThis method must be implemented.