Interface CredentialEntry

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

A CredentialEntry represents an academic record entry for a credential.

  • Method Details

    • getStudentId

      Id getStudentId()
      Gets the Id of the Student .
      Returns:
      the student Id
      Compliance:
      mandatory - This method must be implemented.

    • getStudent

      Resource getStudent() throws OperationFailedException
      Gets the Student .
      Returns:
      the student
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialId

      Id getCredentialId()
      Gets the Id of the Credential .
      Returns:
      the credential Id
      Compliance:
      mandatory - This method must be implemented.

    • getCredential

      Credential getCredential() throws OperationFailedException
      Gets the Credential .
      Returns:
      the credential
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isMatriculationKnown

      boolean isMatriculationKnown()
      Tests if the matriculation status for this credential entry is known.
      Returns:
      true if the matriculation status is known, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getStartDate

      DateTime getStartDate()
      Gets the start date of the matriculation.
      Specified by:
      getStartDate in interface Temporal
      Returns:
      the start date
      Throws:
      IllegalStateException - isMatriculationKnown() is false
      Compliance:
      mandatory - This method must be implemented.

    • getStartTermId

      Id getStartTermId()
      Gets the Id of the start Term .
      Returns:
      the start term Id
      Throws:
      IllegalStateException - isMatriculationKnown() is false
      Compliance:
      mandatory - This method must be implemented.

    • getStartTerm

      Term getStartTerm() throws OperationFailedException
      Gets the start Term .
      Returns:
      the start term
      Throws:
      IllegalStateException - isMatriculationKnown() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isExpectedToComplete

      boolean isExpectedToComplete()
      Tests if an expected completion is known.
      Returns:
      true if an expected completion is known, false otherwise
      Throws:
      IllegalStateException - isMatriculationKnown() is false
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionDate

      DateTime getExpectedCompletionDate()
      Gets the expected completion date.
      Returns:
      the expected completion date
      Throws:
      IllegalStateException - isExpectedToComplete() is false
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionTermId

      Id getExpectedCompletionTermId()
      Gets the Id of the expected completion Term .
      Returns:
      the expected completion term Id
      Throws:
      IllegalStateException - isExpectedToComplete() is false
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionTerm

      Term getExpectedCompletionTerm() throws OperationFailedException
      Gets the expected completion Term .
      Returns:
      the expected completion term
      Throws:
      IllegalStateException - isExpectedToComplete() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isActivelyPursuing

      boolean isActivelyPursuing()
      Tests if the credential is being actively pursued.
      Returns:
      true if the credential is being actively pursued, false otherwise
      Throws:
      IllegalStateException - isMatriculationKnown() is false
      Compliance:
      mandatory - This method must be implemented.

    • isPaused

      boolean isPaused()
      Tests if the pursuit of the credential is paused.
      Returns:
      true if the pursuit of the credential is paused, false otherwise
      Throws:
      IllegalStateException - isMatriculationKnown() is false
      Compliance:
      mandatory - This method must be implemented.

    • isAbandoned

      boolean isAbandoned()
      Tests if the pursuit of the credential has been abandoned.
      Returns:
      true if the pursuit of the credential has been abandoned, false otherwise
      Throws:
      IllegalStateException - isMatriculationKnown() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAbandonDate

      DateTime getAbandonDate()
      Gets the date the credential was abandoned.
      Returns:
      the abandon date
      Throws:
      IllegalStateException - isAbandoned() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAbandonTermId

      Id getAbandonTermId()
      Gets the Id of the abandon Term .
      Returns:
      the abandon term Id
      Throws:
      IllegalStateException - isAbandoned() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAbandonTerm

      Term getAbandonTerm() throws OperationFailedException
      Gets the abandon Term .
      Returns:
      the abandon term
      Throws:
      IllegalStateException - isAbandoned() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isAwarded

      boolean isAwarded()
      Tests if the credential has been awarded.
      Returns:
      true if the credential has been awarded, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAwardDate

      DateTime getAwardDate()
      Gets the date the credential was awarded.
      Returns:
      the award date
      Throws:
      IllegalStateException - isAwarded() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAwardTermId

      Id getAwardTermId()
      Gets the Id of the award Term .
      Returns:
      the award term Id
      Throws:
      IllegalStateException - isAwarded() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAwardTerm

      Term getAwardTerm() throws OperationFailedException
      Gets the award Term .
      Returns:
      the award term
      Throws:
      IllegalStateException - isAwarded() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getDateAwarded

      DateTime getDateAwarded()
      Gets the award date.
      Returns:
      the date awarded
      Compliance:
      mandatory - This method must be implemented.

    • hasProgram

      boolean hasProgram()
      Tests if a program is associated with this credential.
      Returns:
      true if a program is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProgramId

      Id getProgramId()
      Gets the Id of the Program .
      Returns:
      the program Id
      Throws:
      IllegalStateException - hasProgram() is false
      Compliance:
      mandatory - This method must be implemented.

    • getProgram

      Program getProgram() throws OperationFailedException
      Gets the Program .
      Returns:
      the program
      Throws:
      IllegalStateException - hasProgram() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialEntryRecord

      CredentialEntryRecord getCredentialEntryRecord(Type credentialEntryRecordType) throws OperationFailedException
      Gets the credential entry record corresponding to the given CredentialEntry record Type . This method is used to retrieve an object implementing the requested record. The credentialEntryRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(credentialEntryRecordType) is true .
      Parameters:
      credentialEntryRecordType - the type of credential entry record to retrieve
      Returns:
      the credential entry record
      Throws:
      NullArgumentException - credentialEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(credentialEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.