public interface MapQuery extends OsidCatalogQuery
This is the query for searching maps. Each method match specifies an
AND
term while multiple invocations of the same method
produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAncestorMapIdTerms()
Clears the ancestor map
Id query terms. |
void |
clearAncestorMapTerms()
Clears the ancestor map query terms.
|
void |
clearDescendantMapIdTerms()
Clears the descendant map
Id query terms. |
void |
clearDescendantMapTerms()
Clears the descendant map query terms.
|
void |
clearLocationIdTerms()
Clears the location
Id query terms. |
void |
clearLocationTerms()
Clears the location query terms.
|
void |
clearPathIdTerms()
Clears the path
Id query terms. |
void |
clearPathTerms()
Clears the path query terms.
|
void |
clearRouteIdTerms()
Clears the route
Id query terms. |
void |
clearRouteTerms()
Clears the route query terms.
|
MapQuery |
getAncestorMapQuery()
Gets the query for a map.
|
MapQuery |
getDescendantMapQuery()
Gets the query for a map.
|
LocationQuery |
getLocationQuery()
Gets the query for a location.
|
MapQueryRecord |
getMapQueryRecord(Type mapRecordType)
Gets the map query record corresponding to the given
Map
record Type. |
PathQuery |
getPathQuery()
Gets the query for a path.
|
RouteQuery |
getRouteQuery()
Gets the query for a route.
|
void |
matchAncestorMapId(Id mapId,
boolean match)
Sets the map
Id for this query to match maps that have
the specified map as an ancestor. |
void |
matchAnyAncestorMap(boolean match)
Matches maps with any ancestor.
|
void |
matchAnyDescendantMap(boolean match)
Matches maps with any descendant.
|
void |
matchAnyLocation(boolean match)
Matches maps that have any location.
|
void |
matchAnyPath(boolean match)
Matches maps that have any path.
|
void |
matchAnyRoute(boolean match)
Matches maps that have any route.
|
void |
matchDescendantMapId(Id mapId,
boolean match)
Sets the map
Id for this query to match maps that have
the specified map as a descendant. |
void |
matchLocationId(Id locationId,
boolean match)
Sets the location
Id for this query to match maps that
have a related location. |
void |
matchPathId(Id pathId,
boolean match)
Sets the path
Id for this query to match maps
containing paths. |
void |
matchRouteId(Id pathId,
boolean match)
Sets the path
Id for this query to match maps
containing paths. |
boolean |
supportsAncestorMapQuery()
Tests if a
MapQuery is available. |
boolean |
supportsDescendantMapQuery()
Tests if a
MapQuery is available. |
boolean |
supportsLocationQuery()
Tests if a
LocationQuery is available. |
boolean |
supportsPathQuery()
Tests if a
PathQuery is available. |
boolean |
supportsRouteQuery()
Tests if a
RouteQuery 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 matchLocationId(Id locationId, boolean match)
Id
for this query to match maps that
have a related location.locationId
- a location Id
match
- true
if a positive match, false
for negative matchNullArgumentException
- locationId
is
null
mandatory
- This method must be implemented. void clearLocationIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsLocationQuery()
LocationQuery
is available. true
if a location query is available,
false
otherwisemandatory
- This method must be implemented. LocationQuery getLocationQuery()
OR
term.UnimplementedException
- supportsLocationQuery()
is false
optional
- This method must be implemented if
supportsLocationQuery()
is true.
void matchAnyLocation(boolean match)
match
- true
to match maps with any location,
false
to match maps with no locationmandatory
- This method must be implemented. void clearLocationTerms()
mandatory
- This method must be implemented. void matchPathId(Id pathId, boolean match)
Id
for this query to match maps
containing paths.pathId
- the path Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- pathId
is
null
mandatory
- This method must be implemented. void clearPathIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsPathQuery()
PathQuery
is available. true
if a path query is available, false
otherwisemandatory
- This method must be implemented. PathQuery getPathQuery()
OR
term.UnimplementedException
- supportsPathQuery()
is false
optional
- This method must be implemented if
supportsPathQuery()
is true.
void matchAnyPath(boolean match)
match
- true
to match maps with any path,
false
to match maps with no pathmandatory
- This method must be implemented. void clearPathTerms()
mandatory
- This method must be implemented. void matchRouteId(Id pathId, boolean match)
Id
for this query to match maps
containing paths.pathId
- the path Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- pathId
is
null
mandatory
- This method must be implemented. void clearRouteIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRouteQuery()
RouteQuery
is available. true
if a route query is available,
false
otherwisemandatory
- This method must be implemented. RouteQuery getRouteQuery()
OR
term.UnimplementedException
- supportsRouteQuery()
is false
optional
- This method must be implemented if
supportsRouteQuery()
is true.
void matchAnyRoute(boolean match)
match
- true
to match maps with any route,
false
to match maps with no routemandatory
- This method must be implemented. void clearRouteTerms()
mandatory
- This method must be implemented. void matchAncestorMapId(Id mapId, boolean match)
Id
for this query to match maps that have
the specified map as an ancestor.mapId
- a map Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- mapId
is
null
mandatory
- This method must be implemented. void clearAncestorMapIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAncestorMapQuery()
MapQuery
is available. true
if a map query is available, false
otherwisemandatory
- This method must be implemented. MapQuery getAncestorMapQuery()
OR
term.UnimplementedException
-
supportsAncestorMapQuery()
is false
optional
- This method must be implemented if
supportsAncestorMapQuery()
is true.
void matchAnyAncestorMap(boolean match)
match
- true
to match maps with any ancestor,
false
to match root mapsmandatory
- This method must be implemented. void clearAncestorMapTerms()
mandatory
- This method must be implemented. void matchDescendantMapId(Id mapId, boolean match)
Id
for this query to match maps that have
the specified map as a descendant.mapId
- a map Id
match
- true
for a positive match, false
for negative matchNullArgumentException
- mapId
is
null
mandatory
- This method must be implemented. void clearDescendantMapIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsDescendantMapQuery()
MapQuery
is available. true
if a map query is available, false
otherwisemandatory
- This method must be implemented. MapQuery getDescendantMapQuery()
OR
term.UnimplementedException
-
supportsDescendantMapQuery()
is false
optional
- This method must be implemented if
supportsDescendantMapQuery()
is true.
void matchAnyDescendantMap(boolean match)
match
- true
to match maps with any descendant,
false
to match leaf mapsmandatory
- This method must be implemented. void clearDescendantMapTerms()
mandatory
- This method must be implemented. MapQueryRecord getMapQueryRecord(Type mapRecordType) throws OperationFailedException
Map
record Type.
Multiple record retrievals produce
a nested OR
term.mapRecordType
- a map record typeNullArgumentException
- mapRecordType
is
null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(mapRecordType)
is false
mandatory
- This method must be implemented.