Interface | osid.resourcing.rules.JobConstrainerEnablerQuery | ||
---|---|---|---|
Implements | osid.OsidEnablerQuery | ||
Description |
This is the query for searching job constrainer enablers.
Each method match specifies an | ||
Method | matchRuledJobConstrainerId | ||
Description |
Matches enablers mapped to the job constrainer. | ||
Parameters | osid.id.Id | jobConstrainerId | the job constrainer Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | jobConstrainerId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRuledJobConstrainerIdTerms | ||
Description |
Clears the job constrainer | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRuledJobConstrainerQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a job constrainer query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRuledJobConstrainerQuery | ||
Description |
Gets the query for a job constrainer. Multiple
retrievals produce a nested | ||
Return | osid.resourcing.rules.JobConstrainerQuery | the job constrainer query | |
Errors | UNIMPLEMENTED | supportsRuledJobConstrainerQuery() is false | |
Compliance | optional | This method must be implemented if
supportsRuledJobConstrainerQuery() is true. | |
Method | matchAnyRuledJobConstrainer | ||
Description |
Matches enablers mapped to any job constrainer. | ||
Parameters | boolean | 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. | |
Method | clearRuledJobConstrainerTerms | ||
Description |
Clears the job constrainer query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchFoundryId | ||
Description |
Matches enablers mapped to the foundry. | ||
Parameters | osid.id.Id | foundryId | the foundry Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | foundryId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearFoundryIdTerms | ||
Description |
Clears the foundry | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsFoundryQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a foundry query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFoundryQuery | ||
Description |
Gets the query for a foundry. Multiple retrievals
produce a nested | ||
Return | osid.resourcing.FoundryQuery | the foundry query | |
Errors | UNIMPLEMENTED | supportsFoundryQuery() is false | |
Compliance | optional | This method must be implemented if supportsFoundryQuery() is
true. | |
Method | clearFoundryTerms | ||
Description |
Clears the foundry query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getJobConstrainerEnablerQueryRecord | ||
Description |
Gets the job constrainer enabler query record
corresponding to the given | ||
Parameters | osid.type.Type | jobConstrainerEnablerRecordType | a job constrainer enabler record type |
Return | osid.resourcing.rules.records.JobConstrainerEnablerQueryRecord | the job constrainer enabler query record | |
Errors | NULL_ARGUMENT | jobConstrainerEnablerRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(jobConstrainerEnablerRecordType) is
false | ||
Compliance | mandatory | This method must be implemented. |