public interface RenovationQuery extends OsidObjectQuery, OsidTemporalQuery
This is the query for searching for renovations. Each method specifies
an AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearCampusIdTerms()
Clears the campus
Id terms. |
void |
clearCampusTerms()
Clears the campus terms.
|
void |
clearCostTerms()
Clears the cost terms.
|
void |
clearRoomIdTerms()
Clears the room
Id terms. |
void |
clearRoomTerms()
Clears the room terms.
|
CampusQuery |
getCampusQuery()
Gets the query for a campus query.
|
RenovationQueryRecord |
getRenovationQueryRecord(Type renovationRecordType)
Gets the renovation query record corresponding to the given
Renovation record Type. |
RoomQuery |
getRoomQuery()
Gets the query for a renovation.
|
void |
matchAnyCost(boolean match)
Matches any cost.
|
void |
matchCampusId(Id campusId,
boolean match)
Sets the renovation
Id for this query to match rooms
assigned to campuses. |
void |
matchCost(Currency low,
Currency high,
boolean match)
Matches a cost within the given range inclusive.
|
void |
matchRoomId(Id roomId,
boolean match)
Sets the room
Id for this query to match rooms assigned
to renovations. |
boolean |
supportsCampusQuery()
Tests if a
CampusQuery is available. |
boolean |
supportsRoomQuery()
Tests if a room query 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 matchRoomId(Id roomId, boolean match)
Id
for this query to match rooms assigned
to renovations.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 clearRoomIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsRoomQuery()
true
if a room query is available, false
otherwisemandatory
- This method must be implemented. RoomQuery getRoomQuery()
UnimplementedException
- supportsRoomQuery()
is false
optional
- This method must be implemented if
supportsRoomQuery()
is true.
void clearRoomTerms()
mandatory
- This method must be implemented. void matchCost(Currency low, Currency 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 matchAnyCost(boolean match)
match
- true
to match projects with any cost
assigned, false
to match buildings with no cost
assignedmandatory
- This method must be implemented. void clearCostTerms()
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. RenovationQueryRecord getRenovationQueryRecord(Type renovationRecordType) throws OperationFailedException
Renovation
record Type.
Multiple record
retrievals produce a nested boolean OR
term.renovationRecordType
- a renovation record typeNullArgumentException
- renovationRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(renovationRecordType)
is false
mandatory
- This method must be implemented.