org.osid.rules.check

Interface AgendaQuery

All Superinterfaces:

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

public interface AgendaQuery
extends OsidObjectQuery

This is the query for searching agendas. 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	clearEngineIdTerms() Clears the engine Id query terms.
void	clearEngineTerms() Clears the engine query terms.
void	clearInstructionIdTerms() Clears the instruction Id query terms.
void	clearInstructionTerms() Clears the instruction query terms.
AgendaQueryRecord	getAgendaQueryRecord(Type agendaRecordType) Gets the agenda query record corresponding to the given Agenda record Type.
EngineQuery	getEngineQuery() Gets the query for an engine.
InstructionQuery	getInstructionQuery() Gets the query for an instruction.
void	matchAnyInstruction(boolean match) Matches agendas that have any instruction.
void	matchEngineId(Id engineId, boolean match) Sets the engine Id for this query to match agendas assigned to engines.
void	matchInstructionId(Id qualifierId, boolean match) Sets the instruction Id for this query.
boolean	supportsEngineQuery() Tests if a EngineQuery is available.
boolean	supportsInstructionQuery() Tests if an InstructionQuery 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

matchInstructionId

void matchInstructionId(Id qualifierId,
                      boolean match)

Sets the instruction Id for this query.

Parameters:

qualifierId - the instruction Id

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

Throws:

NullArgumentException - instructionId is null

Compliance:

mandatory - This method must be implemented.

clearInstructionIdTerms

void clearInstructionIdTerms()

Clears the instruction Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsInstructionQuery

boolean supportsInstructionQuery()

Tests if an InstructionQuery is available.

Returns:

true if an instruction query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getInstructionQuery

InstructionQuery getInstructionQuery()

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

Returns:

the instruction query

Throws:

UnimplementedException - supportsInstructionQuery() is false

Compliance:

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

matchAnyInstruction

void matchAnyInstruction(boolean match)

Matches agendas that have any instruction.

Parameters:

match - true to match agendas with any instruction, false to match agendas with no instruction

Compliance:

mandatory - This method must be implemented.

clearInstructionTerms

void clearInstructionTerms()

Clears the instruction query terms.

Compliance:

mandatory - This method must be implemented.

matchEngineId

void matchEngineId(Id engineId,
                 boolean match)

Sets the engine Id for this query to match agendas assigned to engines.

Parameters:

engineId - the engine Id

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

Throws:

NullArgumentException - engineId is null

Compliance:

mandatory - This method must be implemented.

clearEngineIdTerms

void clearEngineIdTerms()

Clears the engine Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsEngineQuery

boolean supportsEngineQuery()

Tests if a EngineQuery is available.

Returns:

true if an engine query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getEngineQuery

EngineQuery getEngineQuery()

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

Returns:

the engine query

Throws:

UnimplementedException - supportsEngineQuery() is false

Compliance:

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

clearEngineTerms

void clearEngineTerms()

Clears the engine query terms.

Compliance:

mandatory - This method must be implemented.

getAgendaQueryRecord

AgendaQueryRecord getAgendaQueryRecord(Type agendaRecordType)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

agendaRecordType - an agenda record type

Returns:

the agenda query record

Throws:

NullArgumentException - agendaRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(agendaRecordType) is false

Compliance:

mandatory - This method must be implemented.