org.osid.room

Interface FloorQuery

All Superinterfaces:

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

public interface FloorQuery
extends OsidObjectQuery, OsidTemporalQuery, OsidSubjugateableQuery

This is the query for searching for floors. 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	clearBuildingIdTerms() Clears the building Id terms.
void	clearBuildingTerms() Clears the building terms.
void	clearCampusIdTerms() Clears the campus Id terms.
void	clearCampusTerms() Clears the campus terms.
void	clearGrossAreaTerms() Clears the area terms.
void	clearNumberTerms() Clears the number terms.
void	clearRoomIdTerms() Clears the room Id terms.
void	clearRoomTerms() Clears the room terms.
BuildingQuery	getBuildingQuery() Gets the query for a building query.
CampusQuery	getCampusQuery() Gets the query for a campus query.
FloorQueryRecord	getFloorQueryRecord(Type floorRecordType) Gets the floor query record corresponding to the given Floor record Type.
RoomQuery	getRoomQuery() Gets the query for a floor.
void	matchAnyGrossArea(boolean match) Matches any area.
void	matchAnyNumber(boolean match) Matches any floor number.
void	matchAnyRoom(boolean match) Matches floors.
void	matchBuildingId(Id buildingId, boolean match) Sets the building Id for this query to match floors assigned to buildings.
void	matchCampusId(Id campusId, boolean match) Sets the floor Id for this query to match rooms assigned to campuses.
void	matchGrossArea(java.math.BigDecimal low, java.math.BigDecimal high, boolean match) Matches an area within the given range inclusive.
void	matchNumber(java.lang.String number, Type stringMatchType, boolean match) Sets a floor number.
void	matchRoomId(Id roomId, boolean match) Sets the room Id for this query to match rooms assigned to floors.
boolean	supportsBuildingQuery() Tests if a BuildingQuery is available.
boolean	supportsCampusQuery() Tests if a CampusQuery is available.
boolean	supportsRoomQuery() Tests if a room query is available.

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

matchBuildingId

void matchBuildingId(Id buildingId,
                   boolean match)

Sets the building Id for this query to match floors assigned to buildings.

Parameters:

buildingId - a building Id

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

Throws:

NullArgumentException - buildingId is null

Compliance:

mandatory - This method must be implemented.

clearBuildingIdTerms

void clearBuildingIdTerms()

Clears the building Id terms.

Compliance:

mandatory - This method must be implemented.

supportsBuildingQuery

boolean supportsBuildingQuery()

Tests if a BuildingQuery is available.

Returns:

true if a building query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getBuildingQuery

BuildingQuery getBuildingQuery()

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

Returns:

the building query

Throws:

UnimplementedException - supportsBuildingQuery() is false

Compliance:

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

clearBuildingTerms

void clearBuildingTerms()

Clears the building terms.

Compliance:

mandatory - This method must be implemented.

matchNumber

void matchNumber(java.lang.String number,
               Type stringMatchType,
               boolean match)

Sets a floor number.

Parameters:

number - a number

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - number is not of stringMatchType

NullArgumentException - number is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyNumber

void matchAnyNumber(boolean match)

Matches any floor number.

Parameters:

match - true to match floors with any number, false to match floors with no number

Compliance:

mandatory - This method must be implemented.

clearNumberTerms

void clearNumberTerms()

Clears the number terms.

Compliance:

mandatory - This method must be implemented.

matchGrossArea

void matchGrossArea(java.math.BigDecimal low,
                  java.math.BigDecimal high,
                  boolean match)

Matches an area within the given range inclusive.

Parameters:

low - start of range

high - end of range

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

Throws:

InvalidArgumentException - low is greater than high

Compliance:

mandatory - This method must be implemented.

matchAnyGrossArea

void matchAnyGrossArea(boolean match)

Matches any area.

Parameters:

match - true to match floors with any area, false to match floors with no area assigned

Compliance:

mandatory - This method must be implemented.

clearGrossAreaTerms

void clearGrossAreaTerms()

Clears the area terms.

Compliance:

mandatory - This method must be implemented.

matchRoomId

void matchRoomId(Id roomId,
               boolean match)

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

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 floor.

Returns:

the room query

Throws:

UnimplementedException - supportsRoomQuery() is false

Compliance:

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

matchAnyRoom

void matchAnyRoom(boolean match)

Matches floors. with any room.

Parameters:

match - true to match floors with any room, false to match floors with no rooms

Compliance:

mandatory - This method must be implemented.

clearRoomTerms

void clearRoomTerms()

Clears the room terms.

Compliance:

mandatory - This method must be implemented.

matchCampusId

void matchCampusId(Id campusId,
                 boolean match)

Sets the floor 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.

getFloorQueryRecord

FloorQueryRecord getFloorQueryRecord(Type floorRecordType)
                                     throws OperationFailedException

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

Parameters:

floorRecordType - a floor record type

Returns:

the floor query record

Throws:

NullArgumentException - floorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(floorRecordType) is false

Compliance:

mandatory - This method must be implemented.