public interface CampusQuery extends OsidCatalogQuery
This is the query for searching for campuses. Each method specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorCampusIdTerms()
Clears the ancestor campus
Id terms. |
void |
clearAncestorCampusTerms()
Clears the ancestor campus terms.
|
void |
clearBuildingIdTerms()
Clears the building
Id terms. |
void |
clearBuildingTerms()
Clears the building terms.
|
void |
clearDescendantCampusIdTerms()
Clears the descendant campus
Id terms. |
void |
clearDescendantCampusTerms()
Clears the descendant campus terms.
|
void |
clearFloorIdTerms()
Clears the floor
Id terms. |
void |
clearFloorTerms()
Clears the floor terms.
|
void |
clearRoomIdTerms()
Clears the room
Id terms. |
void |
clearRoomTerms()
Clears the room terms.
|
CampusQuery |
getAncestorCampusQuery()
Gets the query for a campus.
|
BuildingQuery |
getBuildingQuery()
Gets the query for a building query.
|
CampusQueryRecord |
getCampusQueryRecord(Type campusRecordType)
Gets the campus query record corresponding to the given
Campus
record Type. |
CampusQuery |
getDescendantCampusQuery()
Gets the query for a campus.
|
FloorQuery |
getFloorQuery()
Gets the query for a floor.
|
RoomQuery |
getRoomQuery()
Gets the query for a room.
|
void |
matchAncestorCampusId(Id campusId,
boolean match)
Sets the campus
Id for this query to match campuses
that have the specified campus as an ancestor. |
void |
matchAnyAncestorCampus(boolean match)
Matches campuses with any ancestor.
|
void |
matchAnyBuilding(boolean match)
Matches campuses with any building.
|
void |
matchAnyDescendantCampus(boolean match)
Matches campuses with any descendant.
|
void |
matchAnyFloor(boolean match)
Matches campuses with any floor.
|
void |
matchAnyRoom(boolean match)
Matches campuses with any room.
|
void |
matchBuildingId(Id buildingId,
boolean match)
Sets the building
Id for this query to match rooms
assigned to buildings. |
void |
matchDescendantCampusId(Id campusId,
boolean match)
Sets the campus
Id for this query to match campuses
that have the specified campus as a descendant. |
void |
matchFloorId(Id floorId,
boolean match)
Sets the floor
Id for this query to match rooms
assigned to campuses. |
void |
matchRoomId(Id roomId,
boolean match)
Sets the room
Id for this query to match rooms assigned
to campuses. |
boolean |
supportsAncestorCampusQuery()
Tests if a
CampusQuery is available. |
boolean |
supportsBuildingQuery()
Tests if a
BuildingQuery is available. |
boolean |
supportsDescendantCampusQuery()
Tests if a
CampusQuery is available. |
boolean |
supportsFloorQuery()
Tests if a floor query 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
clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery
void matchRoomId(Id roomId, boolean match)
Id
for this query to match rooms assigned
to campuses.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 matchAnyRoom(boolean match)
match
- true
to match campuses with any room,
false
to match campuses with no roomsmandatory
- This method must be implemented. void clearRoomTerms()
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 matchAnyFloor(boolean match)
match
- true
to match campuses with any floor,
false
to match campuses with no floorsmandatory
- This method must be implemented. void clearFloorTerms()
mandatory
- This method must be implemented. 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 matchAnyBuilding(boolean match)
match
- true
to match campuses with any building,
false
to match campuses with no buildingsmandatory
- This method must be implemented. void clearBuildingTerms()
mandatory
- This method must be implemented. void matchAncestorCampusId(Id campusId, boolean match)
Id
for this query to match campuses
that have the specified campus as an ancestor.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 clearAncestorCampusIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsAncestorCampusQuery()
CampusQuery
is available. true
if a campus query is available,
false
otherwisemandatory
- This method must be implemented. CampusQuery getAncestorCampusQuery()
OR
term.UnimplementedException
-
supportsAncestorCampusQuery()
is false
optional
- This method must be implemented if
supportsAncestorCampusQuery()
is true.
void matchAnyAncestorCampus(boolean match)
match
- true
to match campuses with any ancestor,
false
to match root campusesmandatory
- This method must be implemented. void clearAncestorCampusTerms()
mandatory
- This method must be implemented. void matchDescendantCampusId(Id campusId, boolean match)
Id
for this query to match campuses
that have the specified campus as a descendant.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 clearDescendantCampusIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsDescendantCampusQuery()
CampusQuery
is available. true
if a campus query is available,
false
otherwisemandatory
- This method must be implemented. CampusQuery getDescendantCampusQuery()
OR
term.UnimplementedException
-
supportsDescendantCampusQuery()
is false
optional
- This method must be implemented if
supportsDescendantCampusQuery()
is true.
void matchAnyDescendantCampus(boolean match)
match
- true
to match campuses with any
descendant, false
to match leaf campusesmandatory
- This method must be implemented. void clearDescendantCampusTerms()
mandatory
- This method must be implemented. CampusQueryRecord getCampusQueryRecord(Type campusRecordType) throws OperationFailedException
Campus
record Type.
Multiple record retrievals produce
a nested boolean OR
term.campusRecordType
- a campus record typeNullArgumentException
- campusRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(campusRecordType)
is false
mandatory
- This method must be implemented.