org.osid.sequencing

Interface ChainQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

public interface ChainQuery
extends OsidObjectQuery

This is the query for searching chains. 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	clearAntimatroidIdTerms() Clears the antimatroid Id query terms.
void	clearAntimatroidTerms() Clears the antimatroid query terms.
void	clearElementTerms() Clears the element query terms.
void	clearFifoTerms() Clears the fifo query terms.
AntimatroidQuery	getAntimatroidQuery() Gets the query for an antimatroid.
ChainQueryRecord	getChainQueryRecord(Type chainRecordType) Gets the query record corresponding to the given Chain record Type.
void	matchAntimatroidId(Id actionGroupId, boolean match) Sets the action group Id for this query to match sequencinglers assigned to action groups.
void	matchAnyElement(boolean match) Matches chains with any element.
void	matchElement(Id elementId, boolean match) Sets the element Id for this query.
void	matchFifo(boolean match) Matches fifo chains.
boolean	supportsAntimatroidQuery() Tests if an AntimatroidQuery 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

Method Detail

matchFifo

void matchFifo(boolean match)

Matches fifo chains.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearFifoTerms

void clearFifoTerms()

Clears the fifo query terms.

Compliance:

mandatory - This method must be implemented.

matchElement

void matchElement(Id elementId,
                boolean match)

Sets the element Id for this query.

Parameters:

elementId - the element Id

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

Throws:

NullArgumentException - elementId is null

Compliance:

mandatory - This method must be implemented.

matchAnyElement

void matchAnyElement(boolean match)

Matches chains with any element.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearElementTerms

void clearElementTerms()

Clears the element query terms.

Compliance:

mandatory - This method must be implemented.

matchAntimatroidId

void matchAntimatroidId(Id actionGroupId,
                      boolean match)

Sets the action group Id for this query to match sequencinglers assigned to action groups.

Parameters:

actionGroupId - the action group Id

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

Throws:

NullArgumentException - actionGroupId is null

Compliance:

mandatory - This method must be implemented.

clearAntimatroidIdTerms

void clearAntimatroidIdTerms()

Clears the antimatroid Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAntimatroidQuery

boolean supportsAntimatroidQuery()

Tests if an AntimatroidQuery is available.

Returns:

true if an antimatroid query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAntimatroidQuery

AntimatroidQuery getAntimatroidQuery()

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

Returns:

the antimatroid query

Throws:

UnimplementedException - supportsAntimatroidQuery() is false

Compliance:

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

clearAntimatroidTerms

void clearAntimatroidTerms()

Clears the antimatroid query terms.

Compliance:

mandatory - This method must be implemented.

getChainQueryRecord

ChainQueryRecord getChainQueryRecord(Type chainRecordType)
                                     throws OperationFailedException

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

Parameters:

chainRecordType - a chain record type

Returns:

the chain query record

Throws:

NullArgumentException - chainRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(chainRecordType) is false

Compliance:

mandatory - This method must be implemented.