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.
Modifier and Type | Method and 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. |
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(java.math.BigDecimal low,
java.math.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(java.lang.String code,
Type stringMatchType,
boolean match)
Sets a room code.
|
void |
matchDesignatedName(java.lang.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(java.lang.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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchBuildingId(Id buildingId, boolean match)
Id
for this query to match rooms
assigned to buildings.buildingId
- a building Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- buildingId
is
null
mandatory
- This method must be implemented. void clearBuildingIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsBuildingQuery()
BuildingQuery
is available. true
if a building query is available,
false
otherwisemandatory
- This method must be implemented. BuildingQuery getBuildingQuery()
OR
term.UnimplementedException
- supportsBuildingQuery()
is false
optional
- This method must be implemented if
supportsBuildingQuery()
is true.
void clearBuildingTerms()
mandatory
- This method must be implemented. void matchFloorId(Id floorId, boolean match)
Id
for this query to match rooms
assigned to campuses.floorId
- a floor Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- floorId
is
null
mandatory
- This method must be implemented. void clearFloorIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsFloorQuery()
true
if a room query is available, false
otherwisemandatory
- This method must be implemented. FloorQuery getFloorQuery()
UnimplementedException
- supportsFloorQuery()
is false
optional
- This method must be implemented if
supportsFloorQuery()
is true.
void clearFloorTerms()
mandatory
- This method must be implemented. void matchEnclosingRoomId(Id roomId, boolean match)
Id.
roomId
- an enclosing room Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- roomId
is
null
mandatory
- This method must be implemented. void clearEnclosingRoomIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsEnclosingRoomQuery()
EnclosingRoomQuery
is available. true
if an enclosing room query is available,
false
otherwisemandatory
- This method must be implemented. RoomQuery getEnclosingRoomQuery()
OR
term.UnimplementedException
-
supportsEnclosingRoomQuery()
is false
optional
- This method must be implemented if
supportsEnclosingRoomQuery()
is true.
void matchAnyEnclosingRoom(boolean match)
match
- true
for a to match any room enclosed in
another room,, false
otherwisemandatory
- This method must be implemented. void clearEnclosingRoomTerms()
mandatory
- This method must be implemented. void matchSubdivisionId(Id roomId, boolean match)
Id.
roomId
- a subdivision room Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- roomId
is
null
mandatory
- This method must be implemented. void clearSubdivisionIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsSubdivisionQuery()
RoomQuery
is available. true
if a subdivision room query is available,
false
otherwisemandatory
- This method must be implemented. RoomQuery getSubdivisionQuery()
OR
term.UnimplementedException
-
supportsSubdivisionRoomQuery()
is false
optional
- This method must be implemented if
supportsSubdivisionRoomQuery()
is true.
void matchAnySubdivision(boolean match)
match
- true
for a to match any room containg
another room,, false
otherwisemandatory
- This method must be implemented. void clearSubdivisionTerms()
mandatory
- This method must be implemented. void matchDesignatedName(java.lang.String name, Type stringMatchType, boolean match)
name
- an official namestringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- name
is not
of stringMatchType
NullArgumentException
- name
is
null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyDesignatedName(boolean match)
match
- true
to match rooms with any designated
name, false
to match rooms with no designated
namemandatory
- This method must be implemented. void clearDesignatedNameTerms()
mandatory
- This method must be implemented. void matchRoomNumber(java.lang.String number, Type stringMatchType, boolean match)
number
- a numberstringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- number
is not
of stringMatchType
NullArgumentException
- number
is
null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyRoomNumber(boolean match)
match
- true
to match rooms with any number,
false
to match rooms with no numbermandatory
- This method must be implemented. void clearRoomNumberTerms()
mandatory
- This method must be implemented. void matchCode(java.lang.String code, Type stringMatchType, boolean match)
code
- a room codestringMatchType
- a string match typematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- code
is not
of stringMatchType
NullArgumentException
- code
is
null
UnsupportedException
-
supportsStringMatchType(stringMatchType)
is
false
mandatory
- This method must be implemented. void matchAnyCode(boolean match)
match
- true
to match rooms with any code,
false
to match rooms with no codemandatory
- This method must be implemented. void clearCodeTerms()
mandatory
- This method must be implemented. void matchArea(java.math.BigDecimal low, java.math.BigDecimal high, boolean match)
low
- start of rangehigh
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
NullArgumentException
- low
or
high
is null
mandatory
- This method must be implemented. void matchAnyArea(boolean match)
match
- true
to match rooms with any area,
false
to match rooms with no area assignedmandatory
- This method must be implemented. void clearAreaTerms()
mandatory
- This method must be implemented. void matchOccupancyLimit(long low, long high, boolean match)
low
- start of rangehigh
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- low
is
greater than high
mandatory
- This method must be implemented. void matchAnyOccupancyLimit(boolean match)
match
- true
to match rooms with any occupancy
limit, false
to match rooms with no limit
assignedmandatory
- This method must be implemented. void clearOccupancyLimitTerms()
mandatory
- This method must be implemented. void matchResourceId(Id roomId, boolean match)
Id
for this query to match resources
assigned to rooms.roomId
- a room Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- roomId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery()
UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void matchAnyResource(boolean match)
match
- true
to match rooms with any resource,
false
to match rooms with no resourcesmandatory
- This method must be implemented. void clearResourceTerms()
mandatory
- This method must be implemented. void matchCampusId(Id campusId, boolean match)
Id
for this query to match rooms
assigned to campuses.campusId
- a campus Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- campusId
is
null
mandatory
- This method must be implemented. void clearCampusIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsCampusQuery()
CampusQuery
is available. true
if a campus query is available,
false
otherwisemandatory
- This method must be implemented. CampusQuery getCampusQuery()
OR
term.UnimplementedException
- supportsCampusQuery()
is false
optional
- This method must be implemented if
supportsCampusQuery()
is true.
void clearCampusTerms()
mandatory
- This method must be implemented. RoomQueryRecord getRoomQueryRecord(Type roomRecordType) throws OperationFailedException
Room
record Type.
Multiple record retrievals produce
a nested OR
term.roomRecordType
- a room record typeNullArgumentException
- roomRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(roomRecordType)
is false
mandatory
- This method must be implemented.