Interface InstructionQuery

All Superinterfaces:

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

public interface InstructionQuery
extends OsidRelationshipQuery, OsidRuleApplicatorQuery

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

Modifier and Type	Method	Description
void	clearAgendaIdTerms()	Clears the agenda Id query terms.
void	clearAgendaTerms()	Clears the agenda query terms.
void	clearBreakOnSuccessTerms()	Clears the break-on-success 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	clearOrderTerms()	Clears the order 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	matchAnyBreakOnSuccess(boolean match)	Matches instructions that have any break on success status set.
void	matchAnyContinueOnFail(boolean match)	Matches instructions that have any continue on fail status set.
void	matchAnyMessage(boolean match)	Matches instructions that have any message.
void	matchAnyWarning(boolean match)	Matches instructions that have any warning status set.
void	matchBreakOnSuccess(boolean match)	Matches break-on-successl instructions.
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(String message, Type stringMatchType, boolean match)	Adds a message for this query.
void	matchOrder(long from, long to, boolean match)	Matches instructions within the given order range inclusive.
void	matchWarning(boolean match)	Matches warnings.
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 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 OsidEnablerQuery

clearCyclicEventIdTerms, clearCyclicEventTerms, clearCyclicTimePeriodIdTerms, clearCyclicTimePeriodTerms, clearEventIdTerms, clearEventTerms, clearRequirementTerms, clearScheduleIdTerms, clearScheduleTerms, clearTimePeriodIdTerms, clearTimePeriodTerms, getCyclicEventQuery, getCyclicTimePeriodQuery, getEventQuery, getScheduleQuery, getTimePeriodQuery, matchAnyCyclicEvent, matchAnyCyclicTimePeriod, matchAnyEvent, matchAnyRequirement, matchAnySchedule, matchAnyTimePeriod, matchCyclicEventId, matchCyclicTimePeriodId, matchEventId, matchRequirement, matchScheduleId, matchTimePeriodId, supportsCyclicEventQuery, supportsCyclicTimePeriodQuery, supportsEventQuery, supportsScheduleQuery, supportsTimePeriodQuery

Modifier and Type	Method	Description
void	clearCyclicEventIdTerms()	Clears the cyclic event Id query terms.
void	clearCyclicEventTerms()	Clears the cyclic event query terms.
void	clearCyclicTimePeriodIdTerms()	Clears the cyclic time period Id query terms.
void	clearCyclicTimePeriodTerms()	Clears the cyclic time period query terms.
void	clearEventIdTerms()	Clears all event Id terms.
void	clearEventTerms()	Clears all recurirng event terms.
void	clearRequirementTerms()	Clears all requirement terms.
void	clearScheduleIdTerms()	Clears all schedule Id terms.
void	clearScheduleTerms()	Clears all schedule terms.
void	clearTimePeriodIdTerms()	Clears the time period Id query terms.
void	clearTimePeriodTerms()	Clears the time period query terms.
CyclicEventQuery	getCyclicEventQuery()	Gets the query for a cyclic event.
CyclicTimePeriodQuery	getCyclicTimePeriodQuery()	Gets the query for a cyclic time period.
EventQuery	getEventQuery(boolean match)	Gets the query for the event.
ScheduleQuery	getScheduleQuery(boolean match)	Gets the query for the schedule.
TimePeriodQuery	getTimePeriodQuery()	Gets the query for a time period.
void	matchAnyCyclicEvent(boolean match)	Matches any enabler with a cyclic event.
void	matchAnyCyclicTimePeriod(boolean match)	Matches any enabler with a cyclic time period.
void	matchAnyEvent(boolean match)	Match any associated event.
void	matchAnyRequirement(boolean match)	Match OsidEnablers with any requirement flag set.
void	matchAnySchedule(boolean match)	Match any associated schedule.
void	matchAnyTimePeriod(boolean match)	Matches any enabler with a time period.
void	matchCyclicEventId(Id cyclicEventId, boolean match)	Sets the cyclic event Id for this query.
void	matchCyclicTimePeriodId(Id cyclicTimePeriodId, boolean match)	Sets the cyclic time period Id for this query.
void	matchEventId(Id eventId, boolean match)	Match the Id of an associated event.
void	matchRequirement(boolean match)	Matches enablers that are requirements,
void	matchScheduleId(Id scheduleId, boolean match)	Match the Id of an associated schedule.
void	matchTimePeriodId(Id timePeriodId, boolean match)	Sets the time period Id for this query.
boolean	supportsCyclicEventQuery()	Tests if a CyclicEventQuery is available.
boolean	supportsCyclicTimePeriodQuery()	Tests if a CyclicTimePeriod query is available.
boolean	supportsEventQuery()	Tests if a EventQuery for the rule is available.
boolean	supportsScheduleQuery()	Tests if a ScheduleQuery for the rule is available.
boolean	supportsTimePeriodQuery()	Tests if a TimePeriod query is available.

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 OsidOperableQuery

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

Modifier and Type	Method	Description
void	clearActiveTerms()	Clears the active query terms.
void	clearDisabledTerms()	Clears the administratively disabled query terms.
void	clearEnabledTerms()	Clears the administratively enabled query terms.
void	clearOperationalTerms()	Clears the operational query terms.
void	matchActive(boolean match)	Matches active.
void	matchDisabled(boolean match)	Matches administratively disabled.
void	matchEnabled(boolean match)	Matches administratively enabled.
void	matchOperational(boolean match)	Matches operational operables.

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 OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidRuleApplicatorQuery

clearResourceIdTerms, clearResourceTerms, getResourceQuery, matchAnyResource, matchResourceId, supportsResourceQuery

Modifier and Type	Method	Description
void	clearResourceIdTerms()	Clears all resource Id terms.
void	clearResourceTerms()	Clears all resource terms.
ResourceQuery	getResourceQuery(boolean match)	Gets the query for the resource.
void	matchAnyResource(boolean match)	Match any associated resource.
void	matchResourceId(Id resourceId, boolean match)	Match the Id of the resource.
boolean	supportsResourceQuery()	Tests if a ResourceQuery is available.

Methods inherited from interface OsidRuleQuery

clearConditionRecordTypeTerms, clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyConditionRecordType, matchAnyRule, matchConditionRecordType, matchRuleId, supportsRuleQuery

Modifier and Type	Method	Description
void	clearConditionRecordTypeTerms()	Clears the condition record Type query terms.
void	clearRuleIdTerms()	Clears all rule Id terms.
void	clearRuleTerms()	Clears all rule terms.
RuleQuery	getRuleQuery(boolean match)	Gets the query for the rule.
void	matchAnyConditionRecordType(boolean match)	Matches rules with any condition record type.
void	matchAnyRule(boolean match)	Match any associated rule.
void	matchConditionRecordType(Type conditionRecordType, boolean match)	Matches a condition record type.
void	matchRuleId(Id ruleId, boolean match)	Match the Id of the rule.
boolean	supportsRuleQuery()	Tests if a RuleQuery for the rule is available.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

Method Details

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 {@code supportsAgendaQuery()} is {@code 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 {@code supportsCheckQuery()} is {@code true} .

clearCheckTerms

void clearCheckTerms()

Clears the check query terms.

Compliance:

mandatory - This method must be implemented.

matchMessage

void matchMessage(String message,
 Type stringMatchType,
 boolean match)

Adds a message for this query.

Parameters:

message - message string to match

stringMatchType - the string match type

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

Throws:

InvalidArgumentException - message not of stringMatchType

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

Parameters:

match - true to match warnings, false to match hard errors

Compliance:

mandatory - This method must be implemented.

matchAnyWarning

void matchAnyWarning(boolean match)

Matches instructions that have any warning status set.

Parameters:

match - true to match instructions with any warning status set, false otherwise

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.

matchAnyContinueOnFail

void matchAnyContinueOnFail(boolean match)

Matches instructions that have any continue on fail status set.

Parameters:

match - true to match instructions with any continue on fail status set, 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.

matchBreakOnSuccess

void matchBreakOnSuccess(boolean match)

Matches break-on-successl instructions.

Parameters:

match - true to match break-on-successl instructions, false otherwise

Compliance:

mandatory - This method must be implemented.

matchAnyBreakOnSuccess

void matchAnyBreakOnSuccess(boolean match)

Matches instructions that have any break on success status set.

Parameters:

match - true to match instructions with any break on success status set, false otherwise

Compliance:

mandatory - This method must be implemented.

clearBreakOnSuccessTerms

void clearBreakOnSuccessTerms()

Clears the break-on-success 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 {@code supportsEngineQuery()} is {@code true} .

clearEngineTerms

void clearEngineTerms()

Clears the engine query terms.

Compliance:

mandatory - This method must be implemented.

matchOrder

void matchOrder(long from,
 long to,
 boolean match)

Matches instructions within the given order range inclusive.

Parameters:

from - start of range

to - end of range

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

Throws:

InvalidArgumentException - from is greater than to

Compliance:

mandatory - This method must be implemented.

clearOrderTerms

void clearOrderTerms()

Clears the order 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.