Interface ProgramEntryForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidRelationshipForm, OsidTemporalForm, Suppliable
All Known Subinterfaces:
ProgramEntryBatchForm
public interface ProgramEntryForm extends OsidRelationshipForm

This is the form for creating and updating ProgramEntries. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ProgramEntryAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

  • Method Details

    • getIsMatriculationKnownMetadata

      Metadata getIsMatriculationKnownMetadata()
      Gets the metadata for the is matriculation known flag.
      Returns:
      metadata for the is matriculation known flag
      Compliance:
      mandatory - This method must be implemented.

    • setIsMatriculationKnown

      void setIsMatriculationKnown(boolean isMatriculationKnown)
      Sets the is matriculation known flag.
      Parameters:
      isMatriculationKnown - the new is matriculation known flag
      Throws:
      InvalidArgumentException - isMatriculationKnown is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearIsMatriculationKnown

      void clearIsMatriculationKnown()
      Clears the is matriculation known flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getEntranceDateMetadata

      Metadata getEntranceDateMetadata()
      Gets the metadata for the entrance date.
      Returns:
      metadata for the entrance date
      Compliance:
      mandatory - This method must be implemented.

    • setEntranceDate

      void setEntranceDate(DateTime date)
      Sets the entrance date.
      Parameters:
      date - the new date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEntranceDate

      void clearEntranceDate()
      Clears the entrance date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getEntranceTermMetadata

      Metadata getEntranceTermMetadata()
      Gets the metadata for the entrance term.
      Returns:
      metadata for the entrance term
      Compliance:
      mandatory - This method must be implemented.

    • setEntranceTerm

      void setEntranceTerm(Id entranceTermId)
      Sets the entrance term.
      Parameters:
      entranceTermId - the new entrance term
      Throws:
      InvalidArgumentException - entranceTermId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - entranceTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEntranceTerm

      void clearEntranceTerm()
      Clears the entrance term.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getIsExpectedToCompleteMetadata

      Metadata getIsExpectedToCompleteMetadata()
      Gets the metadata for the is expected to complete flag.
      Returns:
      metadata for the is expected to complete flag
      Compliance:
      mandatory - This method must be implemented.

    • setIsExpectedToComplete

      void setIsExpectedToComplete(boolean isExpectedToComplete)
      Sets the is expected to complete flag.
      Parameters:
      isExpectedToComplete - the new is expected to complete flag
      Throws:
      InvalidArgumentException - isExpectedToComplete is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearIsExpectedToComplete

      void clearIsExpectedToComplete()
      Clears the is expected to complete flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionDateMetadata

      Metadata getExpectedCompletionDateMetadata()
      Gets the metadata for the expected completion date.
      Returns:
      metadata for the expected completion date
      Compliance:
      mandatory - This method must be implemented.

    • setExpectedCompletionDate

      void setExpectedCompletionDate(DateTime date)
      Sets the expected completion date.
      Parameters:
      date - the new date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearExpectedCompletionDate

      void clearExpectedCompletionDate()
      Clears the expected completion date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getExpectedCompletionTermMetadata

      Metadata getExpectedCompletionTermMetadata()
      Gets the metadata for the expected completion term.
      Returns:
      metadata for the expected completion term
      Compliance:
      mandatory - This method must be implemented.

    • setExpectedCompletionTerm

      void setExpectedCompletionTerm(Id expectedCompletionTermId)
      Sets the expected completion term.
      Parameters:
      expectedCompletionTermId - the new expected completion term
      Throws:
      InvalidArgumentException - expectedCompletionTermId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - expectedCompletionTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearExpectedCompletionTerm

      void clearExpectedCompletionTerm()
      Clears the expected completion term.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getIsEnrolledMetadata

      Metadata getIsEnrolledMetadata()
      Gets the metadata for the is enrolled flag.
      Returns:
      metadata for the is enrolled flag
      Compliance:
      mandatory - This method must be implemented.

    • setIsEnrolled

      void setIsEnrolled(boolean isEnrolled)
      Sets the is enrolled flag.
      Parameters:
      isEnrolled - the new is enrolled flag
      Throws:
      InvalidArgumentException - isEnrolled is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearIsEnrolled

      void clearIsEnrolled()
      Clears the is enrolled flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getIsActivelyEnrolledMetadata

      Metadata getIsActivelyEnrolledMetadata()
      Gets the metadata for the is actively enrolled flag.
      Returns:
      metadata for the is actively enrolled flag
      Compliance:
      mandatory - This method must be implemented.

    • setIsActivelyEnrolled

      void setIsActivelyEnrolled(boolean isActivelyEnrolled)
      Sets the is actively enrolled flag.
      Parameters:
      isActivelyEnrolled - the new is actively enrolled flag
      Throws:
      InvalidArgumentException - isActivelyEnrolled is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearIsActivelyEnrolled

      void clearIsActivelyEnrolled()
      Clears the is actively enrolled flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getIsOnLeaveMetadata

      Metadata getIsOnLeaveMetadata()
      Gets the metadata for the is on leave flag.
      Returns:
      metadata for the is on leave flag
      Compliance:
      mandatory - This method must be implemented.

    • setIsOnLeave

      void setIsOnLeave(boolean isOnLeave)
      Sets the is on leave flag.
      Parameters:
      isOnLeave - the new is on leave flag
      Throws:
      InvalidArgumentException - isOnLeave is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearIsOnLeave

      void clearIsOnLeave()
      Clears the is on leave flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getHasWithdrawnMetadata

      Metadata getHasWithdrawnMetadata()
      Gets the metadata for the has withdrawn flag.
      Returns:
      metadata for the has withdrawn flag
      Compliance:
      mandatory - This method must be implemented.

    • setHasWithdrawn

      void setHasWithdrawn(boolean hasWithdrawn)
      Sets the has withdrawn flag.
      Parameters:
      hasWithdrawn - the new has withdrawn flag
      Throws:
      InvalidArgumentException - hasWithdrawn is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearHasWithdrawn

      void clearHasWithdrawn()
      Clears the has withdrawn flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getWithdrawDateMetadata

      Metadata getWithdrawDateMetadata()
      Gets the metadata for the withdraw date.
      Returns:
      metadata for the withdraw date
      Compliance:
      mandatory - This method must be implemented.

    • setWithdrawDate

      void setWithdrawDate(DateTime date)
      Sets the withdraw date.
      Parameters:
      date - the new date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearWithdrawDate

      void clearWithdrawDate()
      Clears the withdraw date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getWithdrawTermMetadata

      Metadata getWithdrawTermMetadata()
      Gets the metadata for the withdraw term.
      Returns:
      metadata for the withdraw term
      Compliance:
      mandatory - This method must be implemented.

    • setWithdrawTerm

      void setWithdrawTerm(Id withdrawTermId)
      Sets the withdraw term.
      Parameters:
      withdrawTermId - the new withdraw term
      Throws:
      InvalidArgumentException - withdrawTermId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - withdrawTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearWithdrawTerm

      void clearWithdrawTerm()
      Clears the withdraw term.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCompleteMetadata

      Metadata getCompleteMetadata()
      Gets the metadta for the completionm flag.
      Returns:
      metadata for the complete flag
      Compliance:
      mandatory - This method must be implemented.

    • setComplete

      void setComplete(boolean complete)
      Sets the program is complete flag.
      Parameters:
      complete - the new complete flag
      Throws:
      InvalidArgumentException - complete is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearComplete

      void clearComplete()
      Clears the complete flag.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionDateMetadata

      Metadata getCompletionDateMetadata()
      Gets the metadata for the completion date.
      Returns:
      metadata for the completion date
      Compliance:
      mandatory - This method must be implemented.

    • setCompletionDate

      void setCompletionDate(DateTime date)
      Sets the completion date.
      Parameters:
      date - the new date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCompletionDate

      void clearCompletionDate()
      Clears the completion date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionTermMetadata

      Metadata getCompletionTermMetadata()
      Gets the metadata for the completion term.
      Returns:
      metadata for the completion term
      Compliance:
      mandatory - This method must be implemented.

    • setCompletionTerm

      void setCompletionTerm(Id completionTermId)
      Sets the completion term.
      Parameters:
      completionTermId - the new completion term
      Throws:
      InvalidArgumentException - completionTermId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - completionTermId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCompletionTerm

      void clearCompletionTerm()
      Clears the completion term.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getLevelMetadata

      Metadata getLevelMetadata()
      Gets the metadata for the level.
      Returns:
      metadata for the level
      Compliance:
      mandatory - This method must be implemented.

    • setLevel

      void setLevel(Id levelId)
      Sets the level.
      Parameters:
      levelId - the new level
      Throws:
      InvalidArgumentException - levelId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - levelId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLevel

      void clearLevel()
      Clears the level.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getStandingMetadata

      Metadata getStandingMetadata()
      Gets the metadata for the standing.
      Returns:
      metadata for the standing
      Compliance:
      mandatory - This method must be implemented.

    • setStanding

      void setStanding(Id standingId)
      Sets the standing.
      Parameters:
      standingId - the new standing
      Throws:
      InvalidArgumentException - standingId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - standingId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearStanding

      void clearStanding()
      Clears the standing.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getAdmissionDateMetadata

      Metadata getAdmissionDateMetadata()
      Gets the metadata for the admission date.
      Returns:
      metadata for the admission date
      Compliance:
      mandatory - This method must be implemented.

    • setAdmissionDate

      void setAdmissionDate(DateTime date)
      Sets the admission date.
      Parameters:
      date - the new date
      Throws:
      InvalidArgumentException - date is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - date is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAdmissionDate

      void clearAdmissionDate()
      Clears the admission date.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getTermMetadata

      Metadata getTermMetadata()
      Gets the metadata for the term.
      Returns:
      metadata for the term
      Compliance:
      mandatory - This method must be implemented.

    • setTerm

      void setTerm(Id termId)
      Sets the term.
      Parameters:
      termId - the new term
      Throws:
      InvalidArgumentException - termId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - termId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTerm

      void clearTerm()
      Clears the term.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCreditScaleMetadata

      Metadata getCreditScaleMetadata()
      Gets the metadata for the credit scale.
      Returns:
      metadata for the credit scale
      Compliance:
      mandatory - This method must be implemented.

    • setCreditScale

      void setCreditScale(Id gradeSystemId)
      Sets the credit scale.
      Parameters:
      gradeSystemId - the new grade system
      Throws:
      InvalidArgumentException - gradeSystemId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditScale

      void clearCreditScale()
      Clears the credit scale.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCreditsEarnedMetadata

      Metadata getCreditsEarnedMetadata()
      Gets the metadata for the credits earned.
      Returns:
      metadata for the credits earned
      Compliance:
      mandatory - This method must be implemented.

    • setCreditsEarned

      void setCreditsEarned(BigDecimal credits)
      Sets the credits earned.
      Parameters:
      credits - the new credits
      Throws:
      InvalidArgumentException - credits is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearCreditsEarned

      void clearCreditsEarned()
      Clears the credits earned.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGPAScaleMetadata

      Metadata getGPAScaleMetadata()
      Gets the metadata for the gpa scale.
      Returns:
      metadata for the gpa scale
      Compliance:
      mandatory - This method must be implemented.

    • setGPAScale

      void setGPAScale(Id gradeSystemId)
      Sets the gpa scale.
      Parameters:
      gradeSystemId - the new grade system
      Throws:
      InvalidArgumentException - gradeSystemId is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - gradeSystemId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearGPAScale

      void clearGPAScale()
      Clears the gpa scale.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getGPAMetadata

      Metadata getGPAMetadata()
      Gets the metadata for the gpa.
      Returns:
      metadata for the gpa
      Compliance:
      mandatory - This method must be implemented.

    • setGPA

      void setGPA(BigDecimal gpa)
      Sets the gpa.
      Parameters:
      gpa - the new gpa
      Throws:
      InvalidArgumentException - gpa is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearGPA

      void clearGPA()
      Clears the gpa.
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getProgramEntryFormRecord

      ProgramEntryFormRecord getProgramEntryFormRecord(Type programEntryRecordType) throws OperationFailedException
      Gets the ProgramEntryFormRecord corresponding to the given program entry record Type.
      Parameters:
      programEntryRecordType - a program entry record type
      Returns:
      the program entry form record
      Throws:
      NullArgumentException - programEntryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(programEntryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.