org.osid.room.squatting

Interface LeaseQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable

public interface LeaseQuery
extends OsidRelationshipQuery

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.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCampusIdTerms() Clears the campus Id terms.
void	clearCampusTerms() Clears the campus terms.
void	clearRoomIdTerms() Clears the room Id terms.
void	clearRoomTerms() Clears the room terms.
void	clearTenantIdTerms() Clears the tenant Id terms.
void	clearTenantTerms() Clears the tenant terms.
CampusQuery	getCampusQuery() Gets the query for a campus query.
LeaseQueryRecord	getLeaseQueryRecord(Type leaseRecordType) Gets the lease query record corresponding to the given Lease record Type.
RoomQuery	getRoomQuery() Gets the query for a lease.
ResourceQuery	getTenantQuery() Gets the query for a tenant resource.
void	matchCampusId(Id campusId, boolean match) Sets the lease Id for this query to match rooms assigned to campuses.
void	matchRoomId(Id roomId, boolean match) Sets the room Id for this query to match rooms assigned to leases.
void	matchTenantId(Id resourceId, boolean match) Sets the resource Id for this query to match rooms assigned to leases.
boolean	supportsCampusQuery() Tests if a CampusQuery is available.
boolean	supportsRoomQuery() Tests if a room query is available.
boolean	supportsTenantQuery() Tests if a tenant query is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchRoomId

void matchRoomId(Id roomId,
               boolean match)

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

Parameters:

roomId - a room Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - roomId is null

Compliance:

mandatory - This method must be implemented.

clearRoomIdTerms

void clearRoomIdTerms()

Clears the room Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRoomQuery

boolean supportsRoomQuery()

Tests if a room query is available.

Returns:

true if a room query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRoomQuery

RoomQuery getRoomQuery()

Gets the query for a lease.

Returns:

the room query

Throws:

UnimplementedException - supportsRoomQuery() is false

Compliance:

optional - This method must be implemented if supportsRoomQuery() is true.

clearRoomTerms

void clearRoomTerms()

Clears the room terms.

Compliance:

mandatory - This method must be implemented.

matchTenantId

void matchTenantId(Id resourceId,
                 boolean match)

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

Parameters:

resourceId - a resource Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearTenantIdTerms

void clearTenantIdTerms()

Clears the tenant Id terms.

Compliance:

mandatory - This method must be implemented.

supportsTenantQuery

boolean supportsTenantQuery()

Tests if a tenant query is available.

Returns:

true if a tenant query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getTenantQuery

ResourceQuery getTenantQuery()

Gets the query for a tenant resource.

Returns:

the resource query

Throws:

UnimplementedException - supportsTenantQuery() is false

Compliance:

optional - This method must be implemented if supportsTenantQuery() is true.

clearTenantTerms

void clearTenantTerms()

Clears the tenant terms.

Compliance:

mandatory - This method must be implemented.

matchCampusId

void matchCampusId(Id campusId,
                 boolean match)

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

Parameters:

campusId - a campus Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - campusId is null

Compliance:

mandatory - This method must be implemented.

clearCampusIdTerms

void clearCampusIdTerms()

Clears the campus Id terms.

Compliance:

mandatory - This method must be implemented.

supportsCampusQuery

boolean supportsCampusQuery()

Tests if a CampusQuery is available.

Returns:

true if a campus query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCampusQuery

CampusQuery getCampusQuery()

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

Returns:

the campus query

Throws:

UnimplementedException - supportsCampusQuery() is false

Compliance:

optional - This method must be implemented if supportsCampusQuery() is true.

clearCampusTerms

void clearCampusTerms()

Clears the campus terms.

Compliance:

mandatory - This method must be implemented.

getLeaseQueryRecord

LeaseQueryRecord getLeaseQueryRecord(Type leaseRecordType)
                                     throws OperationFailedException

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

Parameters:

leaseRecordType - a lease record type

Returns:

the lease query record

Throws:

NullArgumentException - leaseRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(leaseRecordType) is false

Compliance:

mandatory - This method must be implemented.