org.osid.rules.check

Interface InstructionQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidEnablerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRelationshipQuery, OsidRuleQuery, OsidTemporalQuery, Suppliable

public interface InstructionQuery
extends OsidRelationshipQuery, OsidEnablerQuery

This is the query for searching instructions. 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	clearAgendaIdTerms() Clears the agenda Id query terms.
void	clearAgendaTerms() Clears the agenda query terms.
void	clearCheckIdTerms() Clears the check Id query terms.
void	clearCheckTerms() Clears the check query terms.
void	clearContinueOnFailTerms() Clears the continue-on-fail query terms.
void	clearEngineIdTerms() Clears the engine Id query terms.
void	clearEngineTerms() Clears the engine query terms.
void	clearMessageTerms() Clears the message query terms.
void	clearWarningTerms() Clears the warning query terms.
AgendaQuery	getAgendaQuery() Gets the query for an agenda.
CheckQuery	getCheckQuery() Gets the query for a check.
EngineQuery	getEngineQuery() Gets the query for an engine.
InstructionQueryRecord	getInstructionQueryRecord(Type instructionRecordType) Gets the instruction query record corresponding to the given Instruction record Type.
void	matchAgendaId(Id agendaId, boolean match) Sets the agenda Id for this query.
void	matchAnyMessage(boolean match) Matches instructions that have any message.
void	matchCheckId(Id checkId, boolean match) Sets the check Id for this query.
void	matchContinueOnFail(boolean match) Matches continue-on-fail instructions.
void	matchEngineId(Id engineId, boolean match) Sets the engine Id for this query to match instructions assigned to engines.
void	matchMessage(java.lang.String message, Type stringMatchType, boolean match) Matches messages.
void	matchWarning(boolean match) Matches warning instructions.
boolean	supportsAgendaQuery() Tests if an AgendaQuery is available.
boolean	supportsCheckQuery() Tests if a CheckQuery is available.
boolean	supportsEngineQuery() Tests if a EngineQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

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

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

matchAgendaId

void matchAgendaId(Id agendaId,
                 boolean match)

Sets the agenda Id for this query.

Parameters:

agendaId - the agenda Id

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

Throws:

NullArgumentException - agendaId is null

Compliance:

mandatory - This method must be implemented.

clearAgendaIdTerms

void clearAgendaIdTerms()

Clears the agenda Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAgendaQuery

boolean supportsAgendaQuery()

Tests if an AgendaQuery is available.

Returns:

true if an agenda query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAgendaQuery

AgendaQuery getAgendaQuery()

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

Returns:

the agenda query

Throws:

UnimplementedException - supportsAgendaQuery() is false

Compliance:

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

clearAgendaTerms

void clearAgendaTerms()

Clears the agenda query terms.

Compliance:

mandatory - This method must be implemented.

matchCheckId

void matchCheckId(Id checkId,
                boolean match)

Sets the check Id for this query.

Parameters:

checkId - the check Id

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

Throws:

NullArgumentException - checkId is null

Compliance:

mandatory - This method must be implemented.

clearCheckIdTerms

void clearCheckIdTerms()

Clears the check Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsCheckQuery

boolean supportsCheckQuery()

Tests if a CheckQuery is available.

Returns:

true if a check query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getCheckQuery

CheckQuery getCheckQuery()

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

Returns:

the check query

Throws:

UnimplementedException - supportsCheckQuery() is false

Compliance:

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

clearCheckTerms

void clearCheckTerms()

Clears the check query terms.

Compliance:

mandatory - This method must be implemented.

matchMessage

void matchMessage(java.lang.String message,
                Type stringMatchType,
                boolean match)

Matches messages.

Parameters:

message - text to match

stringMatchType - the string match type

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

Throws:

NullArgumentException - message or stringMatchType is null

UnsupportedException - supportsStringMatchType(stringMatchType) is false

Compliance:

mandatory - This method must be implemented.

matchAnyMessage

void matchAnyMessage(boolean match)

Matches instructions that have any message.

Parameters:

match - true to match instructions with any message, false to match instructions with no message

Compliance:

mandatory - This method must be implemented.

clearMessageTerms

void clearMessageTerms()

Clears the message query terms.

Compliance:

mandatory - This method must be implemented.

matchWarning

void matchWarning(boolean match)

Matches warning instructions.

Parameters:

match - true to match warning instructions, false to match hard error instructions

Compliance:

mandatory - This method must be implemented.

clearWarningTerms

void clearWarningTerms()

Clears the warning query terms.

Compliance:

mandatory - This method must be implemented.

matchContinueOnFail

void matchContinueOnFail(boolean match)

Matches continue-on-fail instructions.

Parameters:

match - true to match continue-on-fail instructions, false otherwise

Compliance:

mandatory - This method must be implemented.

clearContinueOnFailTerms

void clearContinueOnFailTerms()

Clears the continue-on-fail 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 instructions 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.

getInstructionQueryRecord

InstructionQueryRecord getInstructionQueryRecord(Type instructionRecordType)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

instructionRecordType - an instruction record type

Returns:

the instruction query record

Throws:

NullArgumentException - instructionRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(instructionRecordType) is false

Compliance:

mandatory - This method must be implemented.