org.osid.resourcing.rules

Interface JobProcessorQuery

All Superinterfaces:

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

public interface JobProcessorQuery
extends OsidProcessorQuery

This is the query for searching job processors. 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	clearRuledJobIdTerms() Clears the job Id query terms.
void	clearRuledJobTerms() Clears the job query terms.
FoundryQuery	getFoundryQuery() Gets the query for a foundry.
JobProcessorQueryRecord	getJobProcessorQueryRecord(Type jobProcessorRecordType) Gets the job processor query record corresponding to the given JobProcessor record Type.
JobQuery	getRuledJobQuery() Gets the query for a job.
void	matchAnyRuledJob(boolean match) Matches mapped to any job.
void	matchFoundryId(Id foundryId, boolean match) Matches mapped to the foundry.
void	matchRuledJobId(Id foundryId, boolean match) Matches mapped to the job.
boolean	supportsFoundryQuery() Tests if a FoundryQuery is available.
boolean	supportsRuledJobQuery() Tests if an JobQuery 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

matchRuledJobId

void matchRuledJobId(Id foundryId,
                   boolean match)

Matches mapped to the job.

Parameters:

foundryId - the job Id

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

Throws:

NullArgumentException - foundryId is null

Compliance:

mandatory - This method must be implemented.

clearRuledJobIdTerms

void clearRuledJobIdTerms()

Clears the job Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledJobQuery

boolean supportsRuledJobQuery()

Tests if an JobQuery is available.

Returns:

true if a job query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledJobQuery

JobQuery getRuledJobQuery()

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

Returns:

the job query

Throws:

UnimplementedException - supportsRuledJobQuery() is false

Compliance:

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

matchAnyRuledJob

void matchAnyRuledJob(boolean match)

Matches mapped to any job.

Parameters:

match - true for mapped to any job, false to match mapped to no job

Compliance:

mandatory - This method must be implemented.

clearRuledJobTerms

void clearRuledJobTerms()

Clears the job query terms.

Compliance:

mandatory - This method must be implemented.

matchFoundryId

void matchFoundryId(Id foundryId,
                  boolean match)

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

getJobProcessorQueryRecord

JobProcessorQueryRecord getJobProcessorQueryRecord(Type jobProcessorRecordType)
                                                   throws OperationFailedException

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

Parameters:

jobProcessorRecordType - a job processor record type

Returns:

the job processor query record

Throws:

NullArgumentException - jobProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.