Interface ProficiencyQuery

All Superinterfaces:

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

public interface ProficiencyQuery
extends OsidRelationshipQuery

This is the query for searching proficiencies. Each method match specifies an AND term while multiple invocations of the same method produce a nested OR.

Like all OsidQueries, ProficiencyQuery is stateful and must not be accessed by multiple processing threads.

Method Summary

Modifier and Type	Method	Description
void	clearCompletionTerms()	Clears the completion terms.
void	clearLevelIdTerms()	Clears all level Id terms.
void	clearLevelTerms()	Clears all level terms.
void	clearMinimumCompletionTerms()	Clears the minimum completion terms.
void	clearObjectiveBankIdTerms()	Clears the objective bank Id terms.
void	clearObjectiveBankTerms()	Clears the objective bank terms.
void	clearObjectiveIdTerms()	Clears the objective Id terms.
void	clearObjectiveTerms()	Clears the objective terms.
void	clearResourceIdTerms()	Clears the resource Id terms.
void	clearResourceTerms()	Clears the resource terms.
GradeQuery	getLevelQuery()	Gets the query for a grade.
ObjectiveBankQuery	getObjectiveBankQuery()	Gets the query for an objective bank.
ObjectiveQuery	getObjectiveQuery()	Gets the query for an objective.
ProficiencyQueryRecord	getProficiencyQueryRecord(Type proficiencyRecordType)	Gets the proficiency query record corresponding to the given Proficiency record Type.
ResourceQuery	getResourceQuery()	Gets the query for a resource.
void	matchAnyLevel(boolean match)	Matches an assessment offered that has any level assigned.
void	matchAnyObjective(boolean match)	Matches an activity that has any objective assigned.
void	matchCompletion(BigDecimal start, BigDecimal end, boolean match)	Sets the completion for this query to match completion percentages between the given range inclusive.
void	matchLevelId(Id gradeId, boolean match)	Sets the level grade Id for this query.
void	matchMinimumCompletion(BigDecimal completion, boolean match)	Sets the minimum completion for this query.
void	matchObjectiveBankId(Id objectiveBankId, boolean match)	Sets the objective bank Id for this query.
void	matchObjectiveId(Id objectiveId, boolean match)	Sets the objective Id for this query.
void	matchResourceId(Id resourceId, boolean match)	Sets the resource Id for this query.
boolean	supportsLevelQuery()	Tests if a GradeQuery is available.
boolean	supportsObjectiveBankQuery()	Tests if a ObjectiveBankQuery is available for querying resources.
boolean	supportsObjectiveQuery()	Tests if an ObjectiveQuery is available for querying objectives.
boolean	supportsResourceQuery()	Tests if a ResourceQuery is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface 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 OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Details

matchResourceId

void matchResourceId(Id resourceId,
 boolean match)

Sets the resource Id for this query.

Parameters:

resourceId - a resource Id

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

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearResourceIdTerms

void clearResourceIdTerms()

Clears the resource Id terms.

Compliance:

mandatory - This method must be implemented.

supportsResourceQuery

boolean supportsResourceQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getResourceQuery

ResourceQuery getResourceQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsResourceQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsResourceQuery()} is {@code true}.

clearResourceTerms

void clearResourceTerms()

Clears the resource terms.

Compliance:

mandatory - This method must be implemented.

matchObjectiveId

void matchObjectiveId(Id objectiveId,
 boolean match)

Sets the objective Id for this query.

Parameters:

objectiveId - an 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.

clearObjectiveIdTerms

void clearObjectiveIdTerms()

Clears the objective Id terms.

Compliance:

mandatory - This method must be implemented.

supportsObjectiveQuery

boolean supportsObjectiveQuery()

Tests if an ObjectiveQuery is available for querying objectives.

Returns:

true if an objective query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getObjectiveQuery

ObjectiveQuery getObjectiveQuery()

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

Returns:

the objective query

Throws:

UnimplementedException - supportsObjectiveQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveQuery()} is {@code true}.

matchAnyObjective

void matchAnyObjective(boolean match)

Matches an activity that has any objective assigned.

Parameters:

match - true to match activities with any objective, false to match activities with no objective

Compliance:

mandatory - This method must be implemented.

clearObjectiveTerms

void clearObjectiveTerms()

Clears the objective terms.

Compliance:

mandatory - This method must be implemented.

matchCompletion

void matchCompletion(BigDecimal start,
 BigDecimal end,
 boolean match)

Sets the completion for this query to match completion percentages between the given range inclusive.

Parameters:

start - start of range

end - end of range

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

Throws:

InvalidArgumentException - end is less than start

Compliance:

mandatory - This method must be implemented.

clearCompletionTerms

void clearCompletionTerms()

Clears the completion terms.

Compliance:

mandatory - This method must be implemented.

matchMinimumCompletion

void matchMinimumCompletion(BigDecimal completion,
 boolean match)

Sets the minimum completion for this query.

Parameters:

completion - completion percentage

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

Compliance:

mandatory - This method must be implemented.

clearMinimumCompletionTerms

void clearMinimumCompletionTerms()

Clears the minimum completion terms.

Compliance:

mandatory - This method must be implemented.

matchLevelId

void matchLevelId(Id gradeId,
 boolean match)

Sets the level grade Id for this query.

Parameters:

gradeId - a grade Id

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

Throws:

NullArgumentException - gradeId is null

Compliance:

mandatory - This method must be implemented.

clearLevelIdTerms

void clearLevelIdTerms()

Clears all level Id terms.

Compliance:

mandatory - This method must be implemented.

supportsLevelQuery

boolean supportsLevelQuery()

Tests if a GradeQuery is available.

Returns:

true if a grade query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getLevelQuery

GradeQuery getLevelQuery()

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

Returns:

the grade query

Throws:

UnimplementedException - supportsLevelQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsLevelQuery()} is {@code true}.

matchAnyLevel

void matchAnyLevel(boolean match)

Matches an assessment offered that has any level assigned.

Parameters:

match - true to match offerings with any level, false to match offerings with no levsls

Compliance:

mandatory - This method must be implemented.

clearLevelTerms

void clearLevelTerms()

Clears all level terms.

Compliance:

mandatory - This method must be implemented.

matchObjectiveBankId

void matchObjectiveBankId(Id objectiveBankId,
 boolean match)

Sets the objective bank Id for this query.

Parameters:

objectiveBankId - an objective bank Id

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

Throws:

NullArgumentException - objectiveBankId is null

Compliance:

mandatory - This method must be implemented.

clearObjectiveBankIdTerms

void clearObjectiveBankIdTerms()

Clears the objective bank Id terms.

Compliance:

mandatory - This method must be implemented.

supportsObjectiveBankQuery

boolean supportsObjectiveBankQuery()

Tests if a ObjectiveBankQuery is available for querying resources.

Returns:

true if an objective bank query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getObjectiveBankQuery

ObjectiveBankQuery getObjectiveBankQuery()

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

Returns:

the objective bank query

Throws:

UnimplementedException - supportsObjectiveBankQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsObjectiveBankQuery()} is {@code true}.

clearObjectiveBankTerms

void clearObjectiveBankTerms()

Clears the objective bank terms.

Compliance:

mandatory - This method must be implemented.

getProficiencyQueryRecord

ProficiencyQueryRecord getProficiencyQueryRecord(Type proficiencyRecordType)
                                          throws OperationFailedException

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

Parameters:

proficiencyRecordType - a proficiency offered record type

Returns:

the proficiency offered query record

Throws:

NullArgumentException - proficiencyOfferedRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(proficiencyOfferedRecordType) is false

Compliance:

mandatory - This method must be implemented.