Interface | osid.resourcing.WorkQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
osid.OsidSubjugateableQuery | |||
Description |
This is the query for searching works. Each method match
specifies an | ||
Method | matchJobId | ||
Description |
Sets the job | ||
Parameters | osid.id.Id | jobId | the job Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | jobId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearJobIdTerms | ||
Description |
Clears the job | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsJobQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a job query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getJobQuery | ||
Description |
Gets the query for a job. Multiple retrievals produce a
nested | ||
Return | osid.resourcing.JobQuery | the job query | |
Errors | UNIMPLEMENTED | supportsJobQuery() is false | |
Compliance | optional | This method must be implemented if supportsJobQuery() is
true. | |
Method | clearJobTerms | ||
Description |
Clears the job query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCompetencyId | ||
Description |
Sets the competency | ||
Parameters | osid.id.Id | competencyId | the competency Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | competencyId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCompetencyIdTerms | ||
Description |
Clears the competency | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsCompetencyQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a competency query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCompetencyQuery | ||
Description |
Gets the query for a competency. Multiple retrievals
produce a nested | ||
Return | osid.resourcing.CompetencyQuery | the competency query | |
Errors | UNIMPLEMENTED | supportscompetencyQuery() is false | |
Compliance | optional | This method must be implemented if supportscompetencyQuery()
is true. | |
Method | matchAnyCompetency | ||
Description |
Matches work that have any competency. | ||
Parameters | boolean | match | true to match work with any competency, false
to match work with no competency |
Compliance | mandatory | This method must be implemented. | |
Method | clearCompetencyTerms | ||
Description |
Clears the competency query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCreatedDate | ||
Description |
Matches the creation date between the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | start | start of date range |
osid.calendaring.DateTime | end | end of date range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | start or end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | clearCreatedDateTerms | ||
Description |
Clears the creation date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCompletionDate | ||
Description |
Matches the completion date between the given date range inclusive. | ||
Parameters | osid.calendaring.DateTime | start | start of date range |
osid.calendaring.DateTime | end | end of date range | |
boolean | match | true for a positive match, false for a
negative match | |
Errors | INVALID_ARGUMENT | start is greater than end | |
NULL_ARGUMENT | start or end is null | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyCompletionDate | ||
Description |
Matches work that have any completion date. | ||
Parameters | boolean | match | true to match completed work, false to match
incomplete work |
Compliance | mandatory | This method must be implemented. | |
Method | clearCompletionDateTerms | ||
Description |
Clears the completion date query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchCommissionId | ||
Description |
Sets the commission | ||
Parameters | osid.id.Id | commissionId | the availability Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | commissionId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearCommissionIdTerms | ||
Description |
Clears the commission | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAvailabilityQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a commission query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getCommissionQuery | ||
Description |
Gets the query for a commission. Multiple retrievals
produce a nested | ||
Return | osid.resourcing.CommissionQuery | the commission query | |
Errors | UNIMPLEMENTED | supportsCommissionQuery() is false | |
Compliance | optional | This method must be implemented if supportsCommissionQuery()
is true. | |
Method | matchAnyCommission | ||
Description |
Matches work that have any commission. | ||
Parameters | boolean | match | true to match work with any commission, false
to match work with no availability |
Compliance | mandatory | This method must be implemented. | |
Method | clearCommissionTerms | ||
Description |
Clears the commission query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchFoundryId | ||
Description |
Sets 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 | getWorkQueryRecord | ||
Description |
Gets the work query record corresponding to the given
| ||
Parameters | osid.type.Type | workRecordType | a work record type |
Return | osid.resourcing.records.WorkQueryRecord | the work query record | |
Errors | NULL_ARGUMENT | workRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(workRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |