org.osid.resourcing.rules

Interface JobConstrainerEnablerQuery

All Superinterfaces:

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

public interface JobConstrainerEnablerQuery
extends OsidEnablerQuery

This is the query for searching job constrainer 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	clearRuledJobConstrainerIdTerms() Clears the job constrainer Id query terms.
void	clearRuledJobConstrainerTerms() Clears the job constrainer query terms.
FoundryQuery	getFoundryQuery() Gets the query for a foundry.
JobConstrainerEnablerQueryRecord	getJobConstrainerEnablerQueryRecord(Type jobConstrainerEnablerRecordType) Gets the job constrainer enabler query record corresponding to the given JobConstrainerEnabler record Type.
JobConstrainerQuery	getRuledJobConstrainerQuery() Gets the query for a job constrainer.
void	matchAnyRuledJobConstrainer(boolean match) Matches enablers mapped to any job constrainer.
void	matchFoundryId(Id foundryId, boolean match) Matches enablers mapped to the foundry.
void	matchRuledJobConstrainerId(Id jobConstrainerId, boolean match) Matches enablers mapped to the job constrainer.
boolean	supportsFoundryQuery() Tests if a FoundryQuery is available.
boolean	supportsRuledJobConstrainerQuery() Tests if an JobConstrainerQuery 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

matchRuledJobConstrainerId

void matchRuledJobConstrainerId(Id jobConstrainerId,
                              boolean match)

Matches enablers mapped to the job constrainer.

Parameters:

jobConstrainerId - the job constrainer Id

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

Throws:

NullArgumentException - jobConstrainerId is null

Compliance:

mandatory - This method must be implemented.

clearRuledJobConstrainerIdTerms

void clearRuledJobConstrainerIdTerms()

Clears the job constrainer Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsRuledJobConstrainerQuery

boolean supportsRuledJobConstrainerQuery()

Tests if an JobConstrainerQuery is available.

Returns:

true if a job constrainer query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRuledJobConstrainerQuery

JobConstrainerQuery getRuledJobConstrainerQuery()

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

Returns:

the job constrainer query

Throws:

UnimplementedException - supportsRuledJobConstrainerQuery() is false

Compliance:

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

matchAnyRuledJobConstrainer

void matchAnyRuledJobConstrainer(boolean match)

Matches enablers mapped to any job constrainer.

Parameters:

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

Compliance:

mandatory - This method must be implemented.

clearRuledJobConstrainerTerms

void clearRuledJobConstrainerTerms()

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

getJobConstrainerEnablerQueryRecord

JobConstrainerEnablerQueryRecord getJobConstrainerEnablerQueryRecord(Type jobConstrainerEnablerRecordType)
                                                                     throws OperationFailedException

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

Parameters:

jobConstrainerEnablerRecordType - a job constrainer enabler record type

Returns:

the job constrainer enabler query record

Throws:

NullArgumentException - jobConstrainerEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobConstrainerEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.