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.
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. |
clearCyclicEventIdTerms, clearCyclicEventTerms, clearDemographicIdTerms, clearDemographicTerms, clearEventIdTerms, clearEventTerms, clearScheduleIdTerms, clearScheduleTerms, getCyclicEventQuery, getDemographicQuery, getEventQuery, getScheduleQuery, matchAnyCyclicEvent, matchAnyDemographic, matchAnyEvent, matchAnySchedule, matchCyclicEventId, matchDemographicId, matchEventId, matchScheduleId, supportsCyclicEventQuery, supportsDemographicQuery, supportsEventQuery, supportsScheduleQuery
clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchRuledProcessId(Id processId, boolean match)
processId
- the process Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- processId
is
null
mandatory
- This method must be implemented. void clearRuledProcessIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsRuledProcessQuery()
ProcessQuery
is available. true
if a process query is available,
false
otherwisemandatory
- This method must be implemented. ProcessQuery getRuledProcessQuery()
OR
term.UnimplementedException
-
supportsRuledProcessQuery()
is false
optional
- This method must be implemented if
supportsRuledProcessQuery()
is true.
void matchAnyRuledProcess(boolean match)
match
- true
for rules mapped to any process,
false
to match rules mapped to no processsmandatory
- This method must be implemented. void clearRuledProcessTerms()
mandatory
- This method must be implemented. void matchOfficeId(Id officeId, boolean match)
officeId
- the office Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- officeId
is
null
mandatory
- This method must be implemented. void clearOfficeIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsOfficeQuery()
OfficeQuery
is available. true
if an office query is available,
false
otherwisemandatory
- This method must be implemented. OfficeQuery getOfficeQuery()
OR
term.UnimplementedException
- supportsOfficeQuery()
is false
optional
- This method must be implemented if
supportsOfficeQuery()
is true.
void clearOfficeTerms()
mandatory
- This method must be implemented. ProcessEnablerQueryRecord getProcessEnablerQueryRecord(Type processEnablerRecordType) throws OperationFailedException
ProcessEnabler
record Type.
Multiple
record retrievals produce a nested OR
term.processEnablerRecordType
- a process enabler record typeNullArgumentException
- processEnablerRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(processEnablerRecordType)
is
false
mandatory
- This method must be implemented.