Interface JobForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, Suppliable
All Known Subinterfaces:
JobBatchForm
public interface JobForm extends OsidGovernatorForm

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

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

  • Method Details

    • getEmployersMetadata

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

    • setEmployers

      void setEmployers(IdList employerIds)
      Sets the employers.
      Parameters:
      employerIds - the new employers
      Throws:
      InvalidArgumentException - employerIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - employerIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEmployers

      void clearEmployers()
      Removes the employers.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getCompetenciesMetadata

      Metadata getCompetenciesMetadata()
      Gets the metadata for the competencies.
      Returns:
      metadata for the competency
      Compliance:
      mandatory - This method must be implemented.

    • setCompetencies

      void setCompetencies(IdList competencyIds)
      Sets the competencies.
      Parameters:
      competencyIds - the new competencies
      Throws:
      InvalidArgumentException - competencyIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - competencyId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearCompetencies

      void clearCompetencies()
      Removes the competencies.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getJobFormRecord

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