Interface RoomQuery

All Superinterfaces:

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

public interface RoomQuery
extends OsidObjectQuery, OsidTemporalQuery, OsidSubjugateableQuery

This is the query for searching rooms. 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	clearAreaTerms()	Clears the area terms.
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	clearCodeTerms()	Clears the code terms.
void	clearDesignatedNameTerms()	Clears the designated name terms.
void	clearEnclosingRoomIdTerms()	Clears the enclosing room Id terms.
void	clearEnclosingRoomTerms()	Clears the enclosing room terms.
void	clearFloorIdTerms()	Clears the floor Id terms.
void	clearFloorTerms()	Clears the floor terms.
void	clearOccupancyLimitTerms()	Clears the occupancy limit terms.
void	clearResourceIdTerms()	Clears the resource Id terms.
void	clearResourceTerms()	Clears the resource terms.
void	clearRoomNumberTerms()	Clears the room number terms.
void	clearSubdivisionIdTerms()	Clears the subdivision room Id terms.
void	clearSubdivisionTerms()	Clears the subdivision room terms.
BuildingQuery	getBuildingQuery()	Gets the query for a building query.
CampusQuery	getCampusQuery()	Gets the query for a campus query.
RoomQuery	getEnclosingRoomQuery()	Gets the query for an enclosing room query.
FloorQuery	getFloorQuery()	Gets the query for a floor.
ResourceQuery	getResourceQuery()	Gets the query for a room resource.
RoomQueryRecord	getRoomQueryRecord(Type roomRecordType)	Gets the room query record corresponding to the given Room record Type .Multiple record retrievals produce a nested OR term.
RoomQuery	getSubdivisionQuery()	Gets the query for a subdivision room query.
void	matchAnyArea(boolean match)	Matches any area.
void	matchAnyCode(boolean match)	Matches any room code.
void	matchAnyDesignatedName(boolean match)	Matches any designated name.
void	matchAnyEnclosingRoom(boolean match)	Matches any enclosing room.
void	matchAnyOccupancyLimit(boolean match)	Matches rooms with any occupancy limit.
void	matchAnyResource(boolean match)	Matches rooms with any resource.
void	matchAnyRoomNumber(boolean match)	Matches any room number.
void	matchAnySubdivision(boolean match)	Matches any subdivision room.
void	matchArea(BigDecimal low, BigDecimal high, boolean match)	Matches an area within the given range inclusive.
void	matchBuildingId(Id buildingId, boolean match)	Sets the building Id for this query to match rooms assigned to buildings.
void	matchCampusId(Id campusId, boolean match)	Sets the building Id for this query to match rooms assigned to campuses.
void	matchCode(String code, Type stringMatchType, boolean match)	Sets a room code.
void	matchDesignatedName(String name, Type stringMatchType, boolean match)	Sets a name.
void	matchEnclosingRoomId(Id roomId, boolean match)	Sets an enclosing room Id .
void	matchFloorId(Id floorId, boolean match)	Sets the floor Id for this query to match rooms assigned to campuses.
void	matchOccupancyLimit(long low, long high, boolean match)	Matches an occupancy limit within the given range inclusive.
void	matchResourceId(Id roomId, boolean match)	Sets the room Id for this query to match resources assigned to rooms.
void	matchRoomNumber(String number, Type stringMatchType, boolean match)	Sets a room number.
void	matchSubdivisionId(Id roomId, boolean match)	Sets a subdivision room Id .
boolean	supportsBuildingQuery()	Tests if a BuildingQuery is available.
boolean	supportsCampusQuery()	Tests if a CampusQuery is available.
boolean	supportsEnclosingRoomQuery()	Tests if an EnclosingRoomQuery is available.
boolean	supportsFloorQuery()	Tests if a floor query is available.
boolean	supportsResourceQuery()	Tests if a resource query is available.
boolean	supportsSubdivisionQuery()	Tests if a RoomQuery 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

matchBuildingId

void matchBuildingId(Id buildingId,
 boolean match)

Sets the building Id for this query to match rooms 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 {@code supportsBuildingQuery()} is {@code true} .

clearBuildingTerms

void clearBuildingTerms()

Clears the building terms.

Compliance:

mandatory - This method must be implemented.

matchFloorId

void matchFloorId(Id floorId,
 boolean match)

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

Parameters:

floorId - a floor Id

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

Throws:

NullArgumentException - floorId is null

Compliance:

mandatory - This method must be implemented.

clearFloorIdTerms

void clearFloorIdTerms()

Clears the floor Id terms.

Compliance:

mandatory - This method must be implemented.

supportsFloorQuery

boolean supportsFloorQuery()

Tests if a floor query is available.

Returns:

true if a room query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFloorQuery

FloorQuery getFloorQuery()

Gets the query for a floor.

Returns:

the floor query

Throws:

UnimplementedException - supportsFloorQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsFloorQuery()} is {@code true} .

clearFloorTerms

void clearFloorTerms()

Clears the floor terms.

Compliance:

mandatory - This method must be implemented.

matchEnclosingRoomId

void matchEnclosingRoomId(Id roomId,
 boolean match)

Sets an enclosing room Id .

Parameters:

roomId - an enclosing 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.

clearEnclosingRoomIdTerms

void clearEnclosingRoomIdTerms()

Clears the enclosing room Id terms.

Compliance:

mandatory - This method must be implemented.

supportsEnclosingRoomQuery

boolean supportsEnclosingRoomQuery()

Tests if an EnclosingRoomQuery is available.

Returns:

true if an enclosing room query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEnclosingRoomQuery

RoomQuery getEnclosingRoomQuery()

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

Returns:

the room query

Throws:

UnimplementedException - supportsEnclosingRoomQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsEnclosingRoomQuery()} is {@code true} .

matchAnyEnclosingRoom

void matchAnyEnclosingRoom(boolean match)

Matches any enclosing room.

Parameters:

match - true for a to match any room enclosed in another room,, false otherwise

Compliance:

mandatory - This method must be implemented.

clearEnclosingRoomTerms

void clearEnclosingRoomTerms()

Clears the enclosing room terms.

Compliance:

mandatory - This method must be implemented.

matchSubdivisionId

void matchSubdivisionId(Id roomId,
 boolean match)

Sets a subdivision room Id .

Parameters:

roomId - a subdivision 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.

clearSubdivisionIdTerms

void clearSubdivisionIdTerms()

Clears the subdivision room Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSubdivisionQuery

boolean supportsSubdivisionQuery()

Tests if a RoomQuery is available.

Returns:

true if a subdivision room query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubdivisionQuery

RoomQuery getSubdivisionQuery()

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

Returns:

the room query

Throws:

UnimplementedException - supportsSubdivisionRoomQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSubdivisionRoomQuery()} is {@code true} .

matchAnySubdivision

void matchAnySubdivision(boolean match)

Matches any subdivision room.

Parameters:

match - true for a to match any room containg another room,, false otherwise

Compliance:

mandatory - This method must be implemented.

clearSubdivisionTerms

void clearSubdivisionTerms()

Clears the subdivision room terms.

Compliance:

mandatory - This method must be implemented.

matchDesignatedName

void matchDesignatedName(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.

matchAnyDesignatedName

void matchAnyDesignatedName(boolean match)

Matches any designated name.

Parameters:

match - true to match rooms with any designated name, false to match rooms with no designated name

Compliance:

mandatory - This method must be implemented.

clearDesignatedNameTerms

void clearDesignatedNameTerms()

Clears the designated name terms.

Compliance:

mandatory - This method must be implemented.

matchRoomNumber

void matchRoomNumber(String number,
 Type stringMatchType,
 boolean match)

Sets a room 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.

matchAnyRoomNumber

void matchAnyRoomNumber(boolean match)

Matches any room number.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRoomNumberTerms

void clearRoomNumberTerms()

Clears the room number terms.

Compliance:

mandatory - This method must be implemented.

matchCode

void matchCode(String code,
 Type stringMatchType,
 boolean match)

Sets a room code.

Parameters:

code - a room code

stringMatchType - a string match type

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

Throws:

InvalidArgumentException - code is not of stringMatchType

NullArgumentException - code is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyCode

void matchAnyCode(boolean match)

Matches any room code.

Parameters:

match - true to match rooms with any code, false to match rooms with no code

Compliance:

mandatory - This method must be implemented.

clearCodeTerms

void clearCodeTerms()

Clears the code terms.

Compliance:

mandatory - This method must be implemented.

matchArea

void matchArea(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

NullArgumentException - low or high is null

Compliance:

mandatory - This method must be implemented.

matchAnyArea

void matchAnyArea(boolean match)

Matches any area.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAreaTerms

void clearAreaTerms()

Clears the area terms.

Compliance:

mandatory - This method must be implemented.

matchOccupancyLimit

void matchOccupancyLimit(long low,
 long high,
 boolean match)

Matches an occupancy limit 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.

matchAnyOccupancyLimit

void matchAnyOccupancyLimit(boolean match)

Matches rooms with any occupancy limit.

Parameters:

match - true to match rooms with any occupancy limit, false to match rooms with no limit assigned

Compliance:

mandatory - This method must be implemented.

clearOccupancyLimitTerms

void clearOccupancyLimitTerms()

Clears the occupancy limit terms.

Compliance:

mandatory - This method must be implemented.

matchResourceId

void matchResourceId(Id roomId,
 boolean match)

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

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.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a resource query is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

Gets the query for a room resource.

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceQuery()} is {@code true} .

matchAnyResource

void matchAnyResource(boolean match)

Matches rooms with any resource.

Parameters:

match - true to match rooms with any resource, false to match rooms with no resources

Compliance:

mandatory - This method must be implemented.

clearResourceTerms

void clearResourceTerms()

Clears the resource 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.

getRoomQueryRecord

RoomQueryRecord getRoomQueryRecord(Type roomRecordType)
                            throws OperationFailedException

Gets the room query record corresponding to the given Room record Type .Multiple record retrievals produce a nested OR term.

Parameters:

roomRecordType - a room record type

Returns:

the room query record

Throws:

NullArgumentException - roomRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(roomRecordType) is false

Compliance:

mandatory - This method must be implemented.