org.osid.sequencing

Interface AntimatroidQuery

All Superinterfaces:

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

public interface AntimatroidQuery
extends OsidCatalogQuery

This is the query for searching antimatroids. 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	clearAncestorAntimatroidIdTerms() Clears the ancestor antimatroid Id query terms.
void	clearAncestorAntimatroidTerms() Clears the ancestor antimatroid query terms.
void	clearChainIdTerms() Clears the chain Id query terms.
void	clearChainTerms() Clears the chain query terms.
void	clearDescendantAntimatroidIdTerms() Clears the descendant antimatroid Id query terms.
void	clearDescendantAntimatroidTerms() Clears the descendant antimatroid query terms.
AntimatroidQuery	getAncestorAntimatroidQuery() Gets the query for an antimatroid.
AntimatroidQueryRecord	getAntimatroidQueryRecord(Type antimatroidRecordType) Gets the antimatroid query record corresponding to the given Antimatroid record Type.
ChainQuery	getChainQuery() Gets the query for a chain.
AntimatroidQuery	getDescendantAntimatroidQuery() Gets the query for an antimatroid/ Multiple retrievals produce a nested OR term.
void	matchAncestorAntimatroidId(Id antimatroidId, boolean match) Sets the antimatroid Id for this query to match antimatroids that have the specified antimatroid as an ancestor.
void	matchAnyAncestorAntimatroid(boolean match) Matches antimatroids with any ancestor.
void	matchAnyChain(boolean match) Matches action groups with any chain.
void	matchAnyDescendantAntimatroid(boolean match) Matches antimatroids with any descendant.
void	matchChainId(Id chainId, boolean match) Sets the chain Id for this query.
void	matchDescendantAntimatroidId(Id antimatroidId, boolean match) Sets the antimatroid Id for this query to match antimatroids that have the specified antimatroid as a descendant.
boolean	supportsAncestorAntimatroidQuery() Tests if an AntimatroidQuery is available.
boolean	supportsDescendantAntimatroidQuery() Tests if an AntimatroidQuery is available.
boolean	supportsInputQuery() Tests if a ChainQuery 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

matchChainId

void matchChainId(Id chainId,
                boolean match)

Sets the chain Id for this query.

Parameters:

chainId - the chain Id

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

Throws:

NullArgumentException - chainId is null

Compliance:

mandatory - This method must be implemented.

clearChainIdTerms

void clearChainIdTerms()

Clears the chain Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInputQuery

boolean supportsInputQuery()

Tests if a ChainQuery is available.

Returns:

true if an input query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getChainQuery

ChainQuery getChainQuery()

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

Returns:

the chain query

Throws:

UnimplementedException - supportsChainQuery() is false

Compliance:

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

matchAnyChain

void matchAnyChain(boolean match)

Matches action groups with any chain.

Parameters:

match - true to match antimatroids with any chain, false to match antimatroids with no chains

Compliance:

mandatory - This method must be implemented.

clearChainTerms

void clearChainTerms()

Clears the chain query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorAntimatroidId

void matchAncestorAntimatroidId(Id antimatroidId,
                              boolean match)

Sets the antimatroid Id for this query to match antimatroids that have the specified antimatroid as an ancestor.

Parameters:

antimatroidId - an antimatroid Id

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

Throws:

NullArgumentException - antimatroidId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorAntimatroidIdTerms

void clearAncestorAntimatroidIdTerms()

Clears the ancestor antimatroid Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorAntimatroidQuery

boolean supportsAncestorAntimatroidQuery()

Tests if an AntimatroidQuery is available.

Returns:

true if an antimatroid query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorAntimatroidQuery

AntimatroidQuery getAncestorAntimatroidQuery()

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

Returns:

the antimatroid query

Throws:

UnimplementedException - supportsAncestorAntimatroidQuery() is false

Compliance:

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

matchAnyAncestorAntimatroid

void matchAnyAncestorAntimatroid(boolean match)

Matches antimatroids with any ancestor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearAncestorAntimatroidTerms

void clearAncestorAntimatroidTerms()

Clears the ancestor antimatroid query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantAntimatroidId

void matchDescendantAntimatroidId(Id antimatroidId,
                                boolean match)

Sets the antimatroid Id for this query to match antimatroids that have the specified antimatroid as a descendant.

Parameters:

antimatroidId - an antimatroid Id

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

Throws:

NullArgumentException - antimatroidId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantAntimatroidIdTerms

void clearDescendantAntimatroidIdTerms()

Clears the descendant antimatroid Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantAntimatroidQuery

boolean supportsDescendantAntimatroidQuery()

Tests if an AntimatroidQuery is available.

Returns:

true if an antimatroid query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantAntimatroidQuery

AntimatroidQuery getDescendantAntimatroidQuery()

Gets the query for an antimatroid/ Multiple retrievals produce a nested OR term.

Returns:

the antimatroid query

Throws:

UnimplementedException - supportsDescendantAntimatroidQuery() is false

Compliance:

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

matchAnyDescendantAntimatroid

void matchAnyDescendantAntimatroid(boolean match)

Matches antimatroids with any descendant.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearDescendantAntimatroidTerms

void clearDescendantAntimatroidTerms()

Clears the descendant antimatroid query terms.

Compliance:

mandatory - This method must be implemented.

getAntimatroidQueryRecord

AntimatroidQueryRecord getAntimatroidQueryRecord(Type antimatroidRecordType)
                                                 throws OperationFailedException

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

Parameters:

antimatroidRecordType - an antimatroid record type

Returns:

the antimatroid query record

Throws:

NullArgumentException - antimatroidRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(antimatroidRecordType) is false

Compliance:

mandatory - This method must be implemented.