public interface CompetencyQuery extends OsidObjectQuery
This is the query for searching competencies. Each method match
specifies an AND
term while multiple invocations of the
same method produce a nested OR.
Modifier and Type | Method and Description |
---|---|
void |
clearAvailabilityIdTerms()
Clears the availability
Id query terms. |
void |
clearAvailabilityTerms()
Clears the availability query terms.
|
void |
clearFoundryIdTerms()
Clears the foundry
Id query terms. |
void |
clearFoundryTerms()
Clears the foundry query terms.
|
void |
clearJobIdTerms()
Clears the job
Id query terms. |
void |
clearJobTerms()
Clears the job query terms.
|
void |
clearLearningObjectiveIdTerms()
Clears the learning objective
Id query terms. |
void |
clearLearningObjectiveTerms()
Clears the learning objective query terms.
|
void |
clearWorkIdTerms()
Clears the work
Id query terms. |
void |
clearWorkTerms()
Clears the work query terms.
|
AvailabilityQuery |
getAvailabilityQuery()
Gets the query for an availability.
|
CompetencyQueryRecord |
getCompetencyQueryRecord(Type competencyRecordType)
Gets the competency query record corresponding to the given
Competency record Type. |
FoundryQuery |
getFoundryQuery()
Gets the query for a foundry.
|
JobQuery |
getJobQuery()
Gets the query for a job.
|
ObjectiveQuery |
getLearningObjectiveQuery()
Gets the query for a learning objective.
|
WorkQuery |
getWorkQuery()
Gets the query for a work.
|
void |
matchAnyAvailability(boolean match)
Matches competencies that are used in any availability.
|
void |
matchAnyJob(boolean match)
Matches competencies that are used in any job.
|
void |
matchAnyLearningObjective(boolean match)
Matches competencies that have any learning objective.
|
void |
matchAnyWork(boolean match)
Matches competencies that are used in any work.
|
void |
matchAvailabilityId(Id availabilityId,
boolean match)
Sets the availability
Id for this query. |
void |
matchFoundryId(Id foundryId,
boolean match)
Sets the foundry
Id for this query to match
competencies assigned to foundries. |
void |
matchJobId(Id jobId,
boolean match)
Sets the job
Id for this query. |
void |
matchLearningObjectiveId(Id objectiveId,
boolean match)
Sets the learning objective
Id for this query. |
void |
matchWorkId(Id workId,
boolean match)
Sets the work
Id for this query. |
boolean |
supportsAvailabilityQuery()
Tests if an
AvailabilityQuery is available. |
boolean |
supportsFoundryQuery()
Tests if a
FoundryQuery is available. |
boolean |
supportsJobQuery()
Tests if a
JobQuery is available. |
boolean |
supportsLearningObjectiveQuery()
Tests if an
ObjectiveQuery is available. |
boolean |
supportsWorkQuery()
Tests if a
WorkQuery is available. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchLearningObjectiveId(Id objectiveId, boolean match)
Id
for this query.objectiveId
- the learning objective Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- objectiveId
is
null
mandatory
- This method must be implemented. void clearLearningObjectiveIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsLearningObjectiveQuery()
ObjectiveQuery
is available. true
if a learning objective query is
available, false
otherwisemandatory
- This method must be implemented. ObjectiveQuery getLearningObjectiveQuery()
OR
term.UnimplementedException
-
supportsLearningObjectiveQuery()
is false
optional
- This method must be implemented if
supportsLearningObjectiveQuery()
is true.
void matchAnyLearningObjective(boolean match)
match
- true
to match competencies with any
learning objective, false
to match competencies
with no learning objectivemandatory
- This method must be implemented. void clearLearningObjectiveTerms()
mandatory
- This method must be implemented. void matchAvailabilityId(Id availabilityId, boolean match)
Id
for this query.availabilityId
- the availability Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- availabilityId
is null
mandatory
- This method must be implemented. void clearAvailabilityIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsAvailabilityQuery()
AvailabilityQuery
is available. true
if an availability query is available,
false
otherwisemandatory
- This method must be implemented. AvailabilityQuery getAvailabilityQuery()
OR
term.UnimplementedException
-
supportsAvailabilityQuery()
is false
optional
- This method must be implemented if
supportsAvailabilityQuery()
is true.
void matchAnyAvailability(boolean match)
match
- true
to match competencies with any
availability, false
to match competencies with
no availabilitymandatory
- This method must be implemented. void clearAvailabilityTerms()
mandatory
- This method must be implemented. void matchWorkId(Id workId, boolean match)
Id
for this query.workId
- the work Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- workId
is
null
mandatory
- This method must be implemented. void clearWorkIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsWorkQuery()
WorkQuery
is available. true
if a work query is available, false
otherwisemandatory
- This method must be implemented. WorkQuery getWorkQuery()
OR
term.UnimplementedException
- supportsWorkQuery()
is false
optional
- This method must be implemented if
supportsWorkQuery()
is true.
void matchAnyWork(boolean match)
match
- true
to match competencies with any work,
false
to match competencies with no workmandatory
- This method must be implemented. void clearWorkTerms()
mandatory
- This method must be implemented. void matchJobId(Id jobId, boolean match)
Id
for this query.jobId
- the job Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- jobId
is
null
mandatory
- This method must be implemented. void clearJobIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsJobQuery()
JobQuery
is available. true
if a job query is available, false
otherwisemandatory
- This method must be implemented. JobQuery getJobQuery()
OR
term.UnimplementedException
- supportsJobQuery()
is false
optional
- This method must be implemented if
supportsJobQuery()
is true.
void matchAnyJob(boolean match)
match
- true
to match competencies with any job,
false
to match competencies with no jobmandatory
- This method must be implemented. void clearJobTerms()
mandatory
- This method must be implemented. void matchFoundryId(Id foundryId, boolean match)
Id
for this query to match
competencies assigned to foundries.foundryId
- the foundry Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- foundryId
is
null
mandatory
- This method must be implemented. void clearFoundryIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsFoundryQuery()
FoundryQuery
is available. true
if a foundry query is available,
false
otherwisemandatory
- This method must be implemented. FoundryQuery getFoundryQuery()
OR
term.UnimplementedException
- supportsFoundryQuery()
is false
optional
- This method must be implemented if
supportsFoundryQuery()
is true.
void clearFoundryTerms()
mandatory
- This method must be implemented. CompetencyQueryRecord getCompetencyQueryRecord(Type competencyRecordType) throws OperationFailedException
Competency
record Type.
Multiple record
retrievals produce a nested OR
term.competencyRecordType
- an competency record typeNullArgumentException
- competencyRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(competencyRecordType)
is false
mandatory
- This method must be implemented.