Interface CredentialEntryForm

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

This is the form for creating and updating CredentialEntries . Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ChronicleAdminSession . 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.

    • getStartDateMetadata

      Metadata getStartDateMetadata()
      Gets the metadata for the start date.
      Specified by:
      getStartDateMetadata in interface OsidTemporalForm
      Returns:
      metadata for the start date
      Compliance:
      mandatory - This method must be implemented.

    • setStartDate

      void setStartDate(DateTime date)
      Sets the start date.
      Specified by:
      setStartDate in interface OsidTemporalForm
      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.

    • clearStartDate

      void clearStartDate()
      Clears the start date.
      Specified by:
      clearStartDate in interface OsidTemporalForm
      Throws:
      NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getStartTermMetadata

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

    • setStartTerm

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

    • clearStartTerm

      void clearStartTerm()
      Clears the start 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.

    • getIsActivelyPursuingMetadata

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

    • setIsActivelyPursuing

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

    • clearIsActivelyPursuing

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

    • getIsPausedMetadata

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

    • setIsPaused

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

    • clearIsPaused

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

    • getIsAbandonedMetadata

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

    • setIsAbandoned

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

    • clearIsAbandoned

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

    • getAbandonDateMetadata

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

    • setAbandonDate

      void setAbandonDate(DateTime date)
      Sets the abandon 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.

    • clearAbandonDate

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

    • getAbandonTermMetadata

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

    • setAbandonTerm

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

    • clearAbandonTerm

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

    • getIsAwardedMetadata

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

    • setIsAwarded

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

    • clearIsAwarded

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

    • getAwardDateMetadata

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

    • setAwardDate

      void setAwardDate(DateTime date)
      Sets the award 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.

    • clearAwardDate

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

    • getAwardTermMetadata

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

    • setAwardTerm

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

    • clearAwardTerm

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

    • getDateAwardedMetadata

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

    • setDateAwarded

      void setDateAwarded(DateTime date)
      Sets the award 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.

    • clearDateAwarded

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

    • getProgramMetadata

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

    • setProgram

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

    • clearProgram

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

    • getCredentialEntryFormRecord

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