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

Modifier and Type	Method	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 .Multiple record retrievals produce a nested OR term.
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 Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidSourceableQuery

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

Modifier and Type	Method	Description
void	clearBrandingIdTerms()	Clears all asset Id terms.
void	clearBrandingTerms()	Clears all branding terms.
void	clearLicenseTerms()	Clears all license terms.
void	clearProviderIdTerms()	Clears all provider Id terms.
void	clearProviderTerms()	Clears all provider terms.
AssetQuery	getBrandingQuery(boolean match)	Gets the query for an asset.
ResourceQuery	getProviderQuery(boolean match)	Gets the query for the provider.
void	matchAnyBranding(boolean match)	Match sourceables with any branding.
void	matchAnyLicense(boolean match)	Matches any object with a license.
void	matchAnyProvider(boolean match)	Match sourceables with a provider value.
void	matchBrandingId(Id assetId, boolean match)	Match the Id of an asset used for branding.
void	matchLicense(String license, Type stringMatchType, boolean match)	Adds a license to match.
void	matchProviderId(Id resourceId, boolean match)	Match the Id of the provider resource.
boolean	supportsBrandingQuery()	Tests if an AssetQuery for the branding is available.
boolean	supportsProviderQuery()	Tests if a ResourceQuery for the provider is available.

Method Details

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 {@code supportsLocationQuery()} is {@code 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 {@code supportsPathQuery()} is {@code 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 {@code supportsRouteQuery()} is {@code 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 {@code supportsAncestorMapQuery()} is {@code 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 {@code supportsDescendantMapQuery()} is {@code 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.