public interface Proficiency extends OsidRelationship
A Proficiency
represents a competency of a leraning
objective.
Modifier and Type | Method and Description |
---|---|
java.math.BigDecimal |
getCompletion()
Gets the completion of this objective as a percentage 0-100.
|
Grade |
getLevel()
Gets the proficiency level expressed as a grade.
|
Id |
getLevelId()
Gets the proficiency level expressed as a grade.
|
Objective |
getObjective()
Gets the objective to whom this proficiency applies.
|
Id |
getObjectiveId()
Gets the objective
Id to whom this proficiency applies. |
ProficiencyRecord |
getProficiencyRecord(Type proficiencyRecordType)
Gets the proficiency record corresponding to the given
Proficiency record Type. |
Resource |
getResource()
Gets the resource to whom this proficiency applies.
|
Id |
getResourceId()
Gets the resource
Id to whom this proficiency applies. |
boolean |
hasLevel()
Tests if a proficiency level is available.
|
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getResourceId()
Id
to whom this proficiency applies. Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getObjectiveId()
Id
to whom this proficiency applies. Id
mandatory
- This method must be implemented. Objective getObjective() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. java.math.BigDecimal getCompletion()
mandatory
- This method must be implemented. boolean hasLevel()
true
if a level is available, false
otherwisemandatory
- This method must be implemented. Id getLevelId()
Id
IllegalStateException
- hasLevel()
is
false
mandatory
- This method must be implemented. Grade getLevel() throws OperationFailedException
IllegalStateException
- hasLevel()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ProficiencyRecord getProficiencyRecord(Type proficiencyRecordType) throws OperationFailedException
Proficiency
record Type.
This method is used to
retrieve an object implementing the requested record. The
proficiencyRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(proficiencyRecordType)
is true
.proficiencyRecordType
- the type of proficiency record to
retrieveNullArgumentException
- proficiencyRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(proficiencyRecordType)
is false
mandatory
- This method must be implemented.