org.osid.workflow.rules

Interface StepConstrainerEnablerQuery

All Superinterfaces:

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

public interface StepConstrainerEnablerQuery
extends OsidEnablerQuery

This is the query for searching step constrainer 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	clearRuledStepConstrainerIdTerms() Clears the step constrainer Id query terms.
void	clearRuledStepConstrainerTerms() Clears the step constrainer query terms.
OfficeQuery	getOfficeQuery() Gets the query for an office.
StepConstrainerQuery	getRuledStepConstrainerQuery() Gets the query for a step constrainer.
StepConstrainerEnablerQueryRecord	getStepConstrainerEnablerQueryRecord(Type stepConstrainerEnablerRecordType) Gets the step constrainer enabler query record corresponding to the given StepConstrainerEnabler record Type.
void	matchAnyRuledStepConstrainer(boolean match) Matches enablers mapped to any step constrainer.
void	matchOfficeId(Id officeId, boolean match) Matches enablers mapped to the office.
void	matchRuledStepConstrainerId(Id stepConstrainerId, boolean match) Matches enablers mapped to the step constrainer.
boolean	supportsOfficeQuery() Tests if an OfficeQuery is available.
boolean	supportsRuledStepConstrainerQuery() Tests if a StepConstrainerQuery 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

matchRuledStepConstrainerId

void matchRuledStepConstrainerId(Id stepConstrainerId,
                               boolean match)

Matches enablers mapped to the step constrainer.

Parameters:

stepConstrainerId - the step constrainer Id

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

Throws:

NullArgumentException - stepConstrainerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledStepConstrainerIdTerms

void clearRuledStepConstrainerIdTerms()

Clears the step constrainer Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledStepConstrainerQuery

boolean supportsRuledStepConstrainerQuery()

Tests if a StepConstrainerQuery is available.

Returns:

true if a step constrainer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledStepConstrainerQuery

StepConstrainerQuery getRuledStepConstrainerQuery()

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

Returns:

the step constrainer query

Throws:

UnimplementedException - supportsRuledStepConstrainerQuery() is false

Compliance:

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

matchAnyRuledStepConstrainer

void matchAnyRuledStepConstrainer(boolean match)

Matches enablers mapped to any step constrainer.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledStepConstrainerTerms

void clearRuledStepConstrainerTerms()

Clears the step constrainer 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.

getStepConstrainerEnablerQueryRecord

StepConstrainerEnablerQueryRecord getStepConstrainerEnablerQueryRecord(Type stepConstrainerEnablerRecordType)
                                                                       throws OperationFailedException

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

Parameters:

stepConstrainerEnablerRecordType - a step constrainer enabler record type

Returns:

the step constrainer enabler query record

Throws:

NullArgumentException - stepConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(stepConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.