org.osid.workflow.rules

Interface ProcessEnablerQuery

All Superinterfaces:

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

public interface ProcessEnablerQuery
extends OsidEnablerQuery

This is the query for searching process enablers. 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	clearOfficeIdTerms() Clears the office Id query terms.
void	clearOfficeTerms() Clears the office query terms.
void	clearRuledProcessIdTerms() Clears the process Id query terms.
void	clearRuledProcessTerms() Clears the process query terms.
OfficeQuery	getOfficeQuery() Gets the query for an office.
ProcessEnablerQueryRecord	getProcessEnablerQueryRecord(Type processEnablerRecordType) Gets the process enabler query record corresponding to the given ProcessEnabler record Type.
ProcessQuery	getRuledProcessQuery() Gets the query for a process.
void	matchAnyRuledProcess(boolean match) Matches rules mapped to any process.
void	matchOfficeId(Id officeId, boolean match) Matches enablers mapped to an office.
void	matchRuledProcessId(Id processId, boolean match) Matches enablers mapped to a process.
boolean	supportsOfficeQuery() Tests if an OfficeQuery is available.
boolean	supportsRuledProcessQuery() Tests if a ProcessQuery 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

matchRuledProcessId

void matchRuledProcessId(Id processId,
                       boolean match)

Matches enablers mapped to a process.

Parameters:

processId - the process Id

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

Throws:

NullArgumentException - processId is null

Compliance:

mandatory - This method must be implemented.

clearRuledProcessIdTerms

void clearRuledProcessIdTerms()

Clears the process Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledProcessQuery

boolean supportsRuledProcessQuery()

Tests if a ProcessQuery is available.

Returns:

true if a process query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledProcessQuery

ProcessQuery getRuledProcessQuery()

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

Returns:

the process query

Throws:

UnimplementedException - supportsRuledProcessQuery() is false

Compliance:

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

matchAnyRuledProcess

void matchAnyRuledProcess(boolean match)

Matches rules mapped to any process.

Parameters:

match - true for rules mapped to any process, false to match rules mapped to no processs

Compliance:

mandatory - This method must be implemented.

clearRuledProcessTerms

void clearRuledProcessTerms()

Clears the process query terms.

Compliance:

mandatory - This method must be implemented.

matchOfficeId

void matchOfficeId(Id officeId,
                 boolean match)

Matches enablers mapped to an 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.

getProcessEnablerQueryRecord

ProcessEnablerQueryRecord getProcessEnablerQueryRecord(Type processEnablerRecordType)
                                                       throws OperationFailedException

Gets the process enabler query record corresponding to the given ProcessEnabler record Type. Multiple record retrievals produce a nested OR term.

Parameters:

processEnablerRecordType - a process enabler record type

Returns:

the process enabler query record

Throws:

NullArgumentException - processEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.