org.osid.workflow.rules

Interface StepProcessorEnablerQuery

All Superinterfaces:

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

public interface StepProcessorEnablerQuery
extends OsidEnablerQuery

This is the query for searching step processor enablers. Each method match specifies a AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearOfficeIdTerms() Clears the office Id query terms.
void	clearOfficeTerms() Clears the office query terms.
void	clearRuledStepProcessorIdTerms() Clears the step processor Id query terms.
void	clearRuledStepProcessorTerms() Clears the step processor query terms.
OfficeQuery	getOfficeQuery() Gets the query for an office.
StepProcessorQuery	getRuledStepProcessorQuery() Gets the query for a step processor.
StepProcessorEnablerQueryRecord	getStepProcessorEnablerQueryRecord(Type stepProcessorEnablerRecordType) Gets the step processor enabler query record corresponding to the given StepProcessorEnabler record Type.
void	matchAnyRuledStepProcessor(boolean match) Matches enablers mapped to any step processor.
void	matchOfficeId(Id officeId, boolean match) Matches enablers mapped to the office.
void	matchRuledStepProcessorId(Id stepProcessorId, boolean match) Matches enablers mapped to the step processor.
boolean	supportsOfficeQuery() Tests if an OfficeQuery is available.
boolean	supportsRuledStepProcessorQuery() Tests if a StepProcessorQuery is available.

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

matchRuledStepProcessorId

void matchRuledStepProcessorId(Id stepProcessorId,
                             boolean match)

Matches enablers mapped to the step processor.

Parameters:

stepProcessorId - the step processor Id

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

Throws:

NullArgumentException - stepProcessorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledStepProcessorIdTerms

void clearRuledStepProcessorIdTerms()

Clears the step processor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledStepProcessorQuery

boolean supportsRuledStepProcessorQuery()

Tests if a StepProcessorQuery is available.

Returns:

true if a step processor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledStepProcessorQuery

StepProcessorQuery getRuledStepProcessorQuery()

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

Returns:

the step processor query

Throws:

UnimplementedException - supportsRuledStepProcessorQuery() is false

Compliance:

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

matchAnyRuledStepProcessor

void matchAnyRuledStepProcessor(boolean match)

Matches enablers mapped to any step processor.

Parameters:

match - true for enablers mapped to any step processor, false to match enablers mapped to no step processors

Compliance:

mandatory - This method must be implemented.

clearRuledStepProcessorTerms

void clearRuledStepProcessorTerms()

Clears the step processor query terms.

Compliance:

mandatory - This method must be implemented.

matchOfficeId

void matchOfficeId(Id officeId,
                 boolean match)

Matches enablers mapped to the office.

Parameters:

officeId - the office Id

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

Throws:

NullArgumentException - officeId is null

Compliance:

mandatory - This method must be implemented.

clearOfficeIdTerms

void clearOfficeIdTerms()

Clears the office Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsOfficeQuery

boolean supportsOfficeQuery()

Tests if an OfficeQuery is available.

Returns:

true if an office query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getOfficeQuery

OfficeQuery getOfficeQuery()

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

Returns:

the office query

Throws:

UnimplementedException - supportsOfficeQuery() is false

Compliance:

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

clearOfficeTerms

void clearOfficeTerms()

Clears the office query terms.

Compliance:

mandatory - This method must be implemented.

getStepProcessorEnablerQueryRecord

StepProcessorEnablerQueryRecord getStepProcessorEnablerQueryRecord(Type stepProcessorEnablerRecordType)
                                                                   throws OperationFailedException

Gets the step processor enabler query record corresponding to the given StepProcessorEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

stepProcessorEnablerRecordType - a step processor enabler record type

Returns:

the step processor enabler query record

Throws:

NullArgumentException - stepProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.