org.osid.mapping

Interface MapQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

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.

Method Summary

Methods

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.

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

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchLocationId

void matchLocationId(Id locationId,
                   boolean match)

Sets the location Id for this query to match maps that have a related location.

Parameters:

locationId - a location Id

match - true if a positive match, false for negative match

Throws:

NullArgumentException - locationId is null

Compliance:

mandatory - This method must be implemented.

clearLocationIdTerms

void clearLocationIdTerms()

Clears the location Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsLocationQuery

boolean supportsLocationQuery()

Tests if a LocationQuery is available.

Returns:

true if a location query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLocationQuery

LocationQuery getLocationQuery()

Gets the query for a location. Multiple retrievals produce a nested OR term.

Returns:

the location query

Throws:

UnimplementedException - supportsLocationQuery() is false

Compliance:

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

matchAnyLocation

void matchAnyLocation(boolean match)

Matches maps that have any location.

Parameters:

match - true to match maps with any location, false to match maps with no location

Compliance:

mandatory - This method must be implemented.

clearLocationTerms

void clearLocationTerms()

Clears the location query terms.

Compliance:

mandatory - This method must be implemented.

matchPathId

void matchPathId(Id pathId,
               boolean match)

Sets the path Id for this query to match maps containing paths.

Parameters:

pathId - the path Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - pathId is null

Compliance:

mandatory - This method must be implemented.

clearPathIdTerms

void clearPathIdTerms()

Clears the path Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsPathQuery

boolean supportsPathQuery()

Tests if a PathQuery is available.

Returns:

true if a path query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getPathQuery

PathQuery getPathQuery()

Gets the query for a path. Multiple retrievals produce a nested OR term.

Returns:

the path query

Throws:

UnimplementedException - supportsPathQuery() is false

Compliance:

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

matchAnyPath

void matchAnyPath(boolean match)

Matches maps that have any path.

Parameters:

match - true to match maps with any path, false to match maps with no path

Compliance:

mandatory - This method must be implemented.

clearPathTerms

void clearPathTerms()

Clears the path query terms.

Compliance:

mandatory - This method must be implemented.

matchRouteId

void matchRouteId(Id pathId,
                boolean match)

Sets the path Id for this query to match maps containing paths.

Parameters:

pathId - the path Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - pathId is null

Compliance:

mandatory - This method must be implemented.

clearRouteIdTerms

void clearRouteIdTerms()

Clears the route Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRouteQuery

boolean supportsRouteQuery()

Tests if a RouteQuery is available.

Returns:

true if a route query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRouteQuery

RouteQuery getRouteQuery()

Gets the query for a route. Multiple retrievals produce a nested OR term.

Returns:

the route query

Throws:

UnimplementedException - supportsRouteQuery() is false

Compliance:

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

matchAnyRoute

void matchAnyRoute(boolean match)

Matches maps that have any route.

Parameters:

match - true to match maps with any route, false to match maps with no route

Compliance:

mandatory - This method must be implemented.

clearRouteTerms

void clearRouteTerms()

Clears the route query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorMapId

void matchAncestorMapId(Id mapId,
                      boolean match)

Sets the map Id for this query to match maps that have the specified map as an ancestor.

Parameters:

mapId - a map Id

match - true for a positive match, false for negative match

Throws:

NullArgumentException - mapId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorMapIdTerms

void clearAncestorMapIdTerms()

Clears the ancestor map Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorMapQuery

boolean supportsAncestorMapQuery()

Tests if a MapQuery is available.

Returns:

true if a map query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorMapQuery

MapQuery getAncestorMapQuery()

Gets the query for a map. Multiple retrievals produce a nested OR term.

Returns:

the map query

Throws:

UnimplementedException - supportsAncestorMapQuery() is false

Compliance:

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

matchAnyAncestorMap

void matchAnyAncestorMap(boolean match)

Matches maps with any ancestor.

Parameters:

match - true to match maps with any ancestor, false to match root maps

Compliance:

mandatory - This method must be implemented.

clearAncestorMapTerms

void clearAncestorMapTerms()

Clears the ancestor map query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantMapId

void matchDescendantMapId(Id mapId,
                        boolean match)

Sets the map Id for this query to match maps that have the specified map as a descendant.

Parameters:

mapId - a map Id

match - true for a positive match, false for negative match

Throws:

NullArgumentException - mapId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantMapIdTerms

void clearDescendantMapIdTerms()

Clears the descendant map Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantMapQuery

boolean supportsDescendantMapQuery()

Tests if a MapQuery is available.

Returns:

true if a map query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantMapQuery

MapQuery getDescendantMapQuery()

Gets the query for a map. Multiple retrievals produce a nested OR term.

Returns:

the map query

Throws:

UnimplementedException - supportsDescendantMapQuery() is false

Compliance:

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

matchAnyDescendantMap

void matchAnyDescendantMap(boolean match)

Matches maps with any descendant.

Parameters:

match - true to match maps with any descendant, false to match leaf maps

Compliance:

mandatory - This method must be implemented.

clearDescendantMapTerms

void clearDescendantMapTerms()

Clears the descendant map query terms.

Compliance:

mandatory - This method must be implemented.

getMapQueryRecord

MapQueryRecord getMapQueryRecord(Type mapRecordType)
                                 throws OperationFailedException

Gets the map query record corresponding to the given Map record Type. Multiple record retrievals produce a nested OR term.

Parameters:

mapRecordType - a map record type

Returns:

the map query record

Throws:

NullArgumentException - mapRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(mapRecordType) is false

Compliance:

mandatory - This method must be implemented.