Interface CandidateForm

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

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

Like all OsidForms, CandidateForm is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getResourceMetadata

      Metadata getResourceMetadata()
      Gets the metadata for the associated resource.
      Returns:
      metadata for the resource
      Compliance:
      mandatory - This method must be implemented.

    • setResource

      void setResource(Id resourceId)
      Sets the resource.
      Parameters:
      resourceId - the resource Id
      Throws:
      InvalidArgumentException - resourceId is invalid
      NullArgumentException - resourceId is null
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearResource

      void clearResource()
      Clears the resource.
      Compliance:
      mandatory - This method must be implemented.

    • getCandidateFormRecord

      CandidateFormRecord getCandidateFormRecord(Type candidateRecordType) throws OperationFailedException
      Gets the CandidateFormRecord corresponding to the given Candidate record Type.
      Parameters:
      candidateRecordType - the candidate record type
      Returns:
      the candidate form record
      Throws:
      NullArgumentException - candidateRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(candidateRecordType) is false
      Compliance:
      mandatory - This method must be implemented.