org.osid.workflow.rules

Interface StepConstrainerQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidConstrainerQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

public interface StepConstrainerQuery
extends OsidConstrainerQuery

This is the query for searching step constrainers. 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	clearRuledStepIdTerms() Clears the step Id query terms.
void	clearRuledStepTerms() Clears the step query terms.
OfficeQuery	getOfficeQuery() Gets the query for an office.
StepQuery	getRuledStepQuery() Gets the query for a step.
StepConstrainerQueryRecord	getStepConstrainerQueryRecord(Type stepConstrainerRecordType) Gets the step constrainer query record corresponding to the given StepConstrainer record Type.
void	matchAnyRuledStep(boolean match) Matches constrainers mapped to any step.
void	matchOfficeId(Id officeId, boolean match) Matches constrainers mapped to the office.
void	matchRuledStepId(Id stepId, boolean match) Matches mapped to a step.
boolean	supportsOfficeQuery() Tests if an OfficeQuery is available.
boolean	supportsRuledStepQuery() Tests if a StepQuery is available.

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

Method Detail

matchRuledStepId

void matchRuledStepId(Id stepId,
                    boolean match)

Matches mapped to a step.

Parameters:

stepId - the step Id

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

Throws:

NullArgumentException - stepId is null

Compliance:

mandatory - This method must be implemented.

clearRuledStepIdTerms

void clearRuledStepIdTerms()

Clears the step Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledStepQuery

boolean supportsRuledStepQuery()

Tests if a StepQuery is available.

Returns:

true if a step query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledStepQuery

StepQuery getRuledStepQuery()

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

Returns:

the step query

Throws:

UnimplementedException - supportsRuledStepQuery() is false

Compliance:

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

matchAnyRuledStep

void matchAnyRuledStep(boolean match)

Matches constrainers mapped to any step.

Parameters:

match - true for constrainers mapped to any step, false to match constrainers mapped to no steps

Compliance:

mandatory - This method must be implemented.

clearRuledStepTerms

void clearRuledStepTerms()

Clears the step query terms.

Compliance:

mandatory - This method must be implemented.

matchOfficeId

void matchOfficeId(Id officeId,
                 boolean match)

Matches constrainers 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.

getStepConstrainerQueryRecord

StepConstrainerQueryRecord getStepConstrainerQueryRecord(Type stepConstrainerRecordType)
                                                         throws OperationFailedException

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

Parameters:

stepConstrainerRecordType - a step constrainer record type

Returns:

the step constrainer query record

Throws:

NullArgumentException - stepConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.