public interface ProjectQuery extends OsidObjectQuery, OsidTemporalQuery
This is the query for searching for projects. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
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 |
clearCostTerms()
Clears the cost terms.
|
BuildingQuery |
getBuildingQuery()
Gets the query for a building query.
|
CampusQuery |
getCampusQuery()
Gets the query for a campus query.
|
ProjectQueryRecord |
getProjectQueryRecord(Type projectRecordType)
Gets the project query record corresponding to the given
Project record Type. |
void |
matchAnyCost(boolean match)
Matches any cost.
|
void |
matchBuildingId(Id buildingId,
boolean match)
Sets a building
Id. |
void |
matchCampusId(Id campusId,
boolean match)
Sets the project
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.
|
boolean |
supportsBuildingQuery()
Tests if a
BuildingQuery is available. |
boolean |
supportsCampusQuery()
Tests if a
CampusQuery 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.
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 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. ProjectQueryRecord getProjectQueryRecord(Type projectRecordType) throws OperationFailedException
Project
record Type.
Multiple record retrievals
produce a nested boolean OR
term.projectRecordType
- a project record typeNullArgumentException
- projectRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(projectRecordType)
is false
mandatory
- This method must be implemented.