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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested boolean OR term.
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(BigDecimal low, BigDecimal high, boolean match)	Matches an area within the given range inclusive.
void	matchNumber(String number, Type stringMatchType, boolean match)	Sets a bulding number.
void	matchOfficialName(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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

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 {@code supportsAddressQuery()} is {@code 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(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(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 {@code supportsEnclosingBuildingQuery()} is {@code 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(BigDecimal low,
 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 {@code supportsRoomQuery()} is {@code 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 {@code supportsCampusQuery()} is {@code 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.