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 .

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

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

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.