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.
Modifier and Type | Method and 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(java.math.BigDecimal start,
java.math.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(java.math.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. |
clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery
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
clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate
void matchResourceId(Id resourceId, boolean match)
Id
for this query.resourceId
- a resource Id
match
- true
if a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearResourceIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsResourceQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getResourceQuery()
OR
term.UnimplementedException
- supportsResourceQuery()
is false
optional
- This method must be implemented if
supportsResourceQuery()
is true.
void clearResourceTerms()
mandatory
- This method must be implemented. void matchObjectiveId(Id objectiveId, boolean match)
Id
for this query.objectiveId
- an objective Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- objectiveId
is
null
mandatory
- This method must be implemented. void clearObjectiveIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsObjectiveQuery()
ObjectiveQuery
is available for querying
objectives. true
if an robjective query is available,
false
otherwisemandatory
- This method must be implemented. ObjectiveQuery getObjectiveQuery()
OR
term.UnimplementedException
-
supportsObjectiveQuery()
is false
optional
- This method must be implemented if
supportsObjectiveQuery()
is true.
void matchAnyObjective(boolean match)
match
- true
to match activities with any
objective, false
to match activities with no
objectivemandatory
- This method must be implemented. void clearObjectiveTerms()
mandatory
- This method must be implemented. void matchCompletion(java.math.BigDecimal start, java.math.BigDecimal end, boolean match)
start
- start of rangeend
- end of rangematch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- end
is less
than start
mandatory
- This method must be implemented. void clearCompletionTerms()
mandatory
- This method must be implemented. void matchMinimumCompletion(java.math.BigDecimal completion, boolean match)
completion
- completion percentagematch
- true
for a positive match, false
for a negative matchmandatory
- This method must be implemented. void clearMinimumCompletionTerms()
mandatory
- This method must be implemented. void matchLevelId(Id gradeId, boolean match)
Id
for this query.gradeId
- a grade Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- gradeId
is
null
mandatory
- This method must be implemented. void clearLevelIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsLevelQuery()
GradeQuery
is available. true
if a grade query is available,
false
otherwisemandatory
- This method must be implemented. GradeQuery getLevelQuery()
OR
term.UnimplementedException
- supportsLevelQuery()
is false
optional
- This method must be implemented if
supportsLevelQuery()
is true.
void matchAnyLevel(boolean match)
match
- true
to match offerings with any level,
false
to match offerings with no levslsmandatory
- This method must be implemented. void clearLevelTerms()
mandatory
- This method must be implemented. void matchObjectiveBankId(Id objectiveBankId, boolean match)
Id
for this query.objectiveBankId
- an objective bank Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- objectiveBankId
is null
mandatory
- This method must be implemented. void clearObjectiveBankIdTerms()
Id
terms.mandatory
- This method must be implemented. boolean supportsObjectiveBankQuery()
ObjectiveBankQuery
is available for querying
resources. true
if an objective bank query is available,
false
otherwisemandatory
- This method must be implemented. ObjectiveBankQuery getObjectiveBankQuery()
OR
term.UnimplementedException
-
supportsObjectiveBankQuery()
is false
optional
- This method must be implemented if
supportsObjectiveBankQuery()
is true.
void clearObjectiveBankTerms()
mandatory
- This method must be implemented. ProficiencyQueryRecord getProficiencyQueryRecord(Type proficiencyRecordType) throws OperationFailedException
Proficiency
record Type.
Multiple retrievals
produce a nested OR
term.proficiencyRecordType
- a proficiency offered record typeNullArgumentException
-
proficiencyOfferedRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(proficiencyOfferedRecordType)
is
false
mandatory
- This method must be implemented.