Interface Proficiency

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Proficiency extends OsidRelationship

A Proficiency represents a competency of a leraning objective.

  • Method Details

    • getResourceId

      Id getResourceId()
      Gets the resource Id to whom this proficiency applies.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getResource

      Resource getResource() throws OperationFailedException
      Gets the resource to whom this proficiency applies.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getObjectiveId

      Id getObjectiveId()
      Gets the objective Id to whom this proficiency applies.
      Returns:
      the objective Id
      Compliance:
      mandatory - This method must be implemented.

    • getObjective

      Objective getObjective() throws OperationFailedException
      Gets the objective to whom this proficiency applies.
      Returns:
      the objective
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCompletion

      BigDecimal getCompletion()
      Gets the completion of this objective as a percentage 0-100.
      Returns:
      the completion
      Compliance:
      mandatory - This method must be implemented.

    • hasLevel

      boolean hasLevel()
      Tests if a proficiency level is available.
      Returns:
      true if a level is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getLevelId

      Id getLevelId()
      Gets the proficiency level expressed as a grade.
      Returns:
      the grade Id
      Throws:
      IllegalStateException - hasLevel() is false
      Compliance:
      mandatory - This method must be implemented.

    • getLevel

      Grade getLevel() throws OperationFailedException
      Gets the proficiency level expressed as a grade.
      Returns:
      the grade
      Throws:
      IllegalStateException - hasLevel() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getProficiencyRecord

      ProficiencyRecord getProficiencyRecord(Type proficiencyRecordType) throws OperationFailedException
      Gets the proficiency record corresponding to the given 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.
      Parameters:
      proficiencyRecordType - the type of proficiency record to retrieve
      Returns:
      the proficiency record
      Throws:
      NullArgumentException - proficiencyRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(proficiencyRecordType) is false
      Compliance:
      mandatory - This method must be implemented.