org.osid.resourcing

Interface CompetencyQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

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.

Method Summary

Methods

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.

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

Method Detail

matchLearningObjectiveId

void matchLearningObjectiveId(Id objectiveId,
                            boolean match)

Sets the learning objective Id for this query.

Parameters:

objectiveId - the learning objective Id

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

Throws:

NullArgumentException - objectiveId is null

Compliance:

mandatory - This method must be implemented.

clearLearningObjectiveIdTerms

void clearLearningObjectiveIdTerms()

Clears the learning objective Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsLearningObjectiveQuery

boolean supportsLearningObjectiveQuery()

Tests if an ObjectiveQuery is available.

Returns:

true if a learning objective query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLearningObjectiveQuery

ObjectiveQuery getLearningObjectiveQuery()

Gets the query for a learning objective. Multiple retrievals produce a nested OR term.

Returns:

the learning objective query

Throws:

UnimplementedException - supportsLearningObjectiveQuery() is false

Compliance:

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

matchAnyLearningObjective

void matchAnyLearningObjective(boolean match)

Matches competencies that have any learning objective.

Parameters:

match - true to match competencies with any learning objective, false to match competencies with no learning objective

Compliance:

mandatory - This method must be implemented.

clearLearningObjectiveTerms

void clearLearningObjectiveTerms()

Clears the learning objective query terms.

Compliance:

mandatory - This method must be implemented.

matchAvailabilityId

void matchAvailabilityId(Id availabilityId,
                       boolean match)

Sets the availability Id for this query.

Parameters:

availabilityId - the availability Id

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

Throws:

NullArgumentException - availabilityId is null

Compliance:

mandatory - This method must be implemented.

clearAvailabilityIdTerms

void clearAvailabilityIdTerms()

Clears the availability Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAvailabilityQuery

boolean supportsAvailabilityQuery()

Tests if an AvailabilityQuery is available.

Returns:

true if an availability query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAvailabilityQuery

AvailabilityQuery getAvailabilityQuery()

Gets the query for an availability. Multiple retrievals produce a nested OR term.

Returns:

the availability query

Throws:

UnimplementedException - supportsAvailabilityQuery() is false

Compliance:

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

matchAnyAvailability

void matchAnyAvailability(boolean match)

Matches competencies that are used in any availability.

Parameters:

match - true to match competencies with any availability, false to match competencies with no availability

Compliance:

mandatory - This method must be implemented.

clearAvailabilityTerms

void clearAvailabilityTerms()

Clears the availability query terms.

Compliance:

mandatory - This method must be implemented.

matchWorkId

void matchWorkId(Id workId,
               boolean match)

Sets the work Id for this query.

Parameters:

workId - the work Id

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

Throws:

NullArgumentException - workId is null

Compliance:

mandatory - This method must be implemented.

clearWorkIdTerms

void clearWorkIdTerms()

Clears the work Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsWorkQuery

boolean supportsWorkQuery()

Tests if a WorkQuery is available.

Returns:

true if a work query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getWorkQuery

WorkQuery getWorkQuery()

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

Returns:

the work query

Throws:

UnimplementedException - supportsWorkQuery() is false

Compliance:

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

matchAnyWork

void matchAnyWork(boolean match)

Matches competencies that are used in any work.

Parameters:

match - true to match competencies with any work, false to match competencies with no work

Compliance:

mandatory - This method must be implemented.

clearWorkTerms

void clearWorkTerms()

Clears the work query terms.

Compliance:

mandatory - This method must be implemented.

matchJobId

void matchJobId(Id jobId,
              boolean match)

Sets the job Id for this query.

Parameters:

jobId - the job Id

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

Throws:

NullArgumentException - jobId is null

Compliance:

mandatory - This method must be implemented.

clearJobIdTerms

void clearJobIdTerms()

Clears the job Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsJobQuery

boolean supportsJobQuery()

Tests if a JobQuery is available.

Returns:

true if a job query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getJobQuery

JobQuery getJobQuery()

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

Returns:

the job query

Throws:

UnimplementedException - supportsJobQuery() is false

Compliance:

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

matchAnyJob

void matchAnyJob(boolean match)

Matches competencies that are used in any job.

Parameters:

match - true to match competencies with any job, false to match competencies with no job

Compliance:

mandatory - This method must be implemented.

clearJobTerms

void clearJobTerms()

Clears the job query terms.

Compliance:

mandatory - This method must be implemented.

matchFoundryId

void matchFoundryId(Id foundryId,
                  boolean match)

Sets the foundry Id for this query to match competencies assigned to foundries.

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.

getCompetencyQueryRecord

CompetencyQueryRecord getCompetencyQueryRecord(Type competencyRecordType)
                                               throws OperationFailedException

Gets the competency query record corresponding to the given Competency record Type. Multiple record retrievals produce a nested OR term.

Parameters:

competencyRecordType - an competency record type

Returns:

the competency query record

Throws:

NullArgumentException - competencyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(competencyRecordType) is false

Compliance:

mandatory - This method must be implemented.