org.osid.resourcing.rules

Interface JobProcessorEnablerQuery

All Superinterfaces:

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

public interface JobProcessorEnablerQuery
extends OsidEnablerQuery

This is the query for searching job processor 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	clearFoundryIdTerms() Clears the foundry Id query terms.
void	clearFoundryTerms() Clears the foundry query terms.
void	clearRuledJobProcessorIdTerms() Clears the job processor Id query terms.
void	clearRuledJobProcessorTerms() Clears the job processor query terms.
FoundryQuery	getFoundryQuery() Gets the query for a foundry.
JobProcessorEnablerQueryRecord	getJobProcessorEnablerQueryRecord(Type jobProcessorEnablerRecordType) Gets the job processor enabler query record corresponding to the given JobProcessorEnabler record Type.
JobProcessorQuery	getRuledJobProcessorQuery() Gets the query for a job processor.
void	matchAnyRuledJobProcessor(boolean match) Matches enablers mapped to any job processor.
void	matchFoundryId(Id foundryId, boolean match) Matches enablers mapped to the foundry.
void	matchRuledJobProcessorId(Id jobProcessorId, boolean match) Matches enablers mapped to the job processor.
boolean	supportsFoundryQuery() Tests if a FoundryQuery is available.
boolean	supportsRuledJobProcessorQuery() Tests if an JobProcessorQuery 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

matchRuledJobProcessorId

void matchRuledJobProcessorId(Id jobProcessorId,
                            boolean match)

Matches enablers mapped to the job processor.

Parameters:

jobProcessorId - the job processor Id

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

Throws:

NullArgumentException - jobProcessorId is null

Compliance:

mandatory - This method must be implemented.

clearRuledJobProcessorIdTerms

void clearRuledJobProcessorIdTerms()

Clears the job processor Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledJobProcessorQuery

boolean supportsRuledJobProcessorQuery()

Tests if an JobProcessorQuery is available.

Returns:

true if a job processor query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledJobProcessorQuery

JobProcessorQuery getRuledJobProcessorQuery()

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

Returns:

the job processor query

Throws:

UnimplementedException - supportsRuledJobProcessorQuery() is false

Compliance:

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

matchAnyRuledJobProcessor

void matchAnyRuledJobProcessor(boolean match)

Matches enablers mapped to any job processor.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledJobProcessorTerms

void clearRuledJobProcessorTerms()

Clears the job processor query terms.

Compliance:

mandatory - This method must be implemented.

matchFoundryId

void matchFoundryId(Id foundryId,
                  boolean match)

Matches enablers mapped to the foundry.

Parameters:

foundryId - the foundry Id

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

Throws:

NullArgumentException - foundryId is null

Compliance:

mandatory - This method must be implemented.

clearFoundryIdTerms

void clearFoundryIdTerms()

Clears the foundry Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsFoundryQuery

boolean supportsFoundryQuery()

Tests if a FoundryQuery is available.

Returns:

true if a foundry query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFoundryQuery

FoundryQuery getFoundryQuery()

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

Returns:

the foundry query

Throws:

UnimplementedException - supportsFoundryQuery() is false

Compliance:

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

clearFoundryTerms

void clearFoundryTerms()

Clears the foundry query terms.

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablerQueryRecord

JobProcessorEnablerQueryRecord getJobProcessorEnablerQueryRecord(Type jobProcessorEnablerRecordType)
                                                                 throws OperationFailedException

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

Parameters:

jobProcessorEnablerRecordType - a job processor enabler record type

Returns:

the job processor enabler query record

Throws:

NullArgumentException - jobProcessorEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobProcessorEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.