Interface | osid.resourcing.CompetencyQuery | ||
---|---|---|---|
Implements | osid.OsidObjectQuery | ||
Description |
This is the query for searching competencies. Each method
match specifies an | ||
Method | matchLearningObjectiveId | ||
Description |
Sets the learning objective | ||
Parameters | osid.id.Id | objectiveId | the learning objective Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | objectiveId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearLearningObjectiveIdTerms | ||
Description |
Clears the learning objective | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsLearningObjectiveQuery | ||
Description |
Tests if an | ||
Return | boolean | true if a learning objective query is available,
false otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getLearningObjectiveQuery | ||
Description |
Gets the query for a learning objective. Multiple
retrievals produce a nested | ||
Return | osid.learning.ObjectiveQuery | the learning objective query | |
Errors | UNIMPLEMENTED | supportsLearningObjectiveQuery() is false | |
Compliance | optional | This method must be implemented if supportsLearningObjectiveQuery()
is true. | |
Method | matchAnyLearningObjective | ||
Description |
Matches competencies that have any learning objective. | ||
Parameters | boolean | match | true to match competencies with any learning objective,
false to match competencies with no learning objective |
Compliance | mandatory | This method must be implemented. | |
Method | clearLearningObjectiveTerms | ||
Description |
Clears the learning objective query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAvailabilityId | ||
Description |
Sets the availability | ||
Parameters | osid.id.Id | availabilityId | the availability Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | availabilityId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAvailabilityIdTerms | ||
Description |
Clears the availability | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAvailabilityQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an availability query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAvailabilityQuery | ||
Description |
Gets the query for an availability. Multiple retrievals
produce a nested | ||
Return | osid.resourcing.AvailabilityQuery | the availability query | |
Errors | UNIMPLEMENTED | supportsAvailabilityQuery() is false | |
Compliance | optional | This method must be implemented if supportsAvailabilityQuery()
is true. | |
Method | matchAnyAvailability | ||
Description |
Matches competencies that are used in any availability. | ||
Parameters | boolean | match | true to match competencies with any availability,
false to match competencies with no availability |
Compliance | mandatory | This method must be implemented. | |
Method | clearAvailabilityTerms | ||
Description |
Clears the availability query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchWorkId | ||
Description |
Sets the work | ||
Parameters | osid.id.Id | workId | the work Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | workId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearWorkIdTerms | ||
Description |
Clears the work | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsWorkQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a work query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getWorkQuery | ||
Description |
Gets the query for a work. Multiple retrievals produce
a nested | ||
Return | osid.resourcing.WorkQuery | the work query | |
Errors | UNIMPLEMENTED | supportsWorkQuery() is false | |
Compliance | optional | This method must be implemented if supportsWorkQuery() is
true. | |
Method | matchAnyWork | ||
Description |
Matches competencies that are used in any work. | ||
Parameters | boolean | match | true to match competencies with any work, false
to match competencies with no work |
Compliance | mandatory | This method must be implemented. | |
Method | clearWorkTerms | ||
Description |
Clears the work query terms. | ||
Compliance | mandatory | This method must be implemented. | |
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 | matchAnyJob | ||
Description |
Matches competencies that are used in any job. | ||
Parameters | boolean | match | true to match competencies with any job, false
to match competencies with no job |
Compliance | mandatory | This method must be implemented. | |
Method | clearJobTerms | ||
Description |
Clears the job 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 | getCompetencyQueryRecord | ||
Description |
Gets the competency query record corresponding to the
given | ||
Parameters | osid.type.Type | competencyRecordType | an competency record type |
Return | osid.resourcing.records.CompetencyQueryRecord | the competency query record | |
Errors | NULL_ARGUMENT | competencyRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(competencyRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |