org.osid.room

Interface BuildingQuery

All Superinterfaces:

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

public interface BuildingQuery
extends OsidObjectQuery, OsidTemporalQuery

This is the query for searching for buildings. 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	clearAddressIdTerms() Clears the address Id terms.
void	clearAddressTerms() Clears the address terms.
void	clearCampusIdTerms() Clears the campus Id terms.
void	clearCampusTerms() Clears the campus terms.
void	clearEnclosingBuildingIdTerms() Clears the building Id terms.
void	clearEnclosingBuildingTerms() Clears the enclosing building terms.
void	clearGrossAreaTerms() Clears the area terms.
void	clearNumberTerms() Clears the building number terms.
void	clearOfficialNameTerms() Clears the official name terms.
void	clearRoomIdTerms() Clears the room Id terms.
void	clearRoomTerms() Clears the room terms.
AddressQuery	getAddressQuery() Gets the query for an address query.
BuildingQueryRecord	getBuildingQueryRecord(Type buildingRecordType) Gets the building query record corresponding to the given Building record Type.
CampusQuery	getCampusQuery() Gets the query for a campus query.
BuildingQuery	getEnclosingBuildingQuery() Gets the query for a building query.
RoomQuery	getRoomQuery() Gets the query for a building.
void	matchAddressId(Id addressId, boolean match) Sets an address Id.
void	matchAnyAddress(boolean match) Matches any address.
void	matchAnyEnclosingBuilding(boolean match) Matches any building.
void	matchAnyGrossArea(boolean match) Matches any area.
void	matchAnyNumber(boolean match) Matches any building number.
void	matchAnyOfficialName(boolean match) Matches any official name.
void	matchAnyRoom(boolean match) Matches buildings with any room.
void	matchCampusId(Id campusId, boolean match) Sets the building Id for this query to match rooms assigned to campuses.
void	matchEnclosingBuildingId(Id buildingId, boolean match) Sets a building Id.
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 bulding number.
void	matchOfficialName(java.lang.String name, Type stringMatchType, boolean match) Sets a name.
void	matchRoomId(Id roomId, boolean match) Sets the room Id for this query to match rooms assigned to buildings.
boolean	supportsAddressQuery() Tests if an AddressQuery is available.
boolean	supportsCampusQuery() Tests if a CampusQuery is available.
boolean	supportsEnclosingBuildingQuery() Tests if a BuildingQuery 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

matchAddressId

void matchAddressId(Id addressId,
                  boolean match)

Sets an address Id.

Parameters:

addressId - an address Id

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

Throws:

NullArgumentException - addressId is null

Compliance:

mandatory - This method must be implemented.

clearAddressIdTerms

void clearAddressIdTerms()

Clears the address Id terms.

Compliance:

mandatory - This method must be implemented.

supportsAddressQuery

boolean supportsAddressQuery()

Tests if an AddressQuery is available.

Returns:

true if an address query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAddressQuery

AddressQuery getAddressQuery()

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

Returns:

the address query

Throws:

UnimplementedException - supportsAddressQuery() is false

Compliance:

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

matchAnyAddress

void matchAnyAddress(boolean match)

Matches any address.

Parameters:

match - true to match buildings with any address, false to match buildings with no address

Compliance:

mandatory - This method must be implemented.

clearAddressTerms

void clearAddressTerms()

Clears the address terms.

Compliance:

mandatory - This method must be implemented.

matchOfficialName

void matchOfficialName(java.lang.String name,
                     Type stringMatchType,
                     boolean match)

Sets a name.

Parameters:

name - an official name

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - name is not of stringMatchType

NullArgumentException - name is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyOfficialName

void matchAnyOfficialName(boolean match)

Matches any official name.

Parameters:

match - true to match buildings with any official name, false to match buildings with no official name

Compliance:

mandatory - This method must be implemented.

clearOfficialNameTerms

void clearOfficialNameTerms()

Clears the official name terms.

Compliance:

mandatory - This method must be implemented.

matchNumber

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

Sets a bulding 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 building number.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearNumberTerms

void clearNumberTerms()

Clears the building number terms.

Compliance:

mandatory - This method must be implemented.

matchEnclosingBuildingId

void matchEnclosingBuildingId(Id buildingId,
                            boolean match)

Sets a building Id.

Parameters:

buildingId - a building Id

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

Throws:

NullArgumentException - addressId is null

Compliance:

mandatory - This method must be implemented.

clearEnclosingBuildingIdTerms

void clearEnclosingBuildingIdTerms()

Clears the building Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEnclosingBuildingQuery

boolean supportsEnclosingBuildingQuery()

Tests if a BuildingQuery is available.

Returns:

true if a building query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEnclosingBuildingQuery

BuildingQuery getEnclosingBuildingQuery()

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

Returns:

the building query

Throws:

UnimplementedException - supportsEnclosingBuildingQuery() is false

Compliance:

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

matchAnyEnclosingBuilding

void matchAnyEnclosingBuilding(boolean match)

Matches any building.

Parameters:

match - true to match buildings with any enclosing building, false to match buildings with no enclosing building

Compliance:

mandatory - This method must be implemented.

clearEnclosingBuildingTerms

void clearEnclosingBuildingTerms()

Clears the enclosing building 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 buildings with any area, false to match buildings 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 buildings.

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

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 buildings with any room.

Parameters:

match - true to match buildings with any room, false to match buildings 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 building 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.

getBuildingQueryRecord

BuildingQueryRecord getBuildingQueryRecord(Type buildingRecordType)
                                           throws OperationFailedException

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

Parameters:

buildingRecordType - a building record type

Returns:

the building query record

Throws:

NullArgumentException - buildingRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(buildingRecordType) is false

Compliance:

mandatory - This method must be implemented.