org.osid.room.construction

Interface RenovationQuery

All Superinterfaces:

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

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.

Method Summary

Methods

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.

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

matchRoomId

void matchRoomId(Id roomId,
               boolean match)

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

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

Returns:

the room query

Throws:

UnimplementedException - supportsRoomQuery() is false

Compliance:

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

clearRoomTerms

void clearRoomTerms()

Clears the room terms.

Compliance:

mandatory - This method must be implemented.

matchCost

void matchCost(Currency low,
             Currency high,
             boolean match)

Matches a cost 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.

matchAnyCost

void matchAnyCost(boolean match)

Matches any cost.

Parameters:

match - true to match projects with any cost assigned, false to match buildings with no cost assigned

Compliance:

mandatory - This method must be implemented.

clearCostTerms

void clearCostTerms()

Clears the cost terms.

Compliance:

mandatory - This method must be implemented.

matchCampusId

void matchCampusId(Id campusId,
                 boolean match)

Sets the renovation 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.

getRenovationQueryRecord

RenovationQueryRecord getRenovationQueryRecord(Type renovationRecordType)
                                               throws OperationFailedException

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

Parameters:

renovationRecordType - a renovation record type

Returns:

the renovation query record

Throws:

NullArgumentException - renovationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(renovationRecordType) is false

Compliance:

mandatory - This method must be implemented.