Interface AppointmentForm

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

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

  • Method Details

    • getCommitmentMetadata

      Metadata getCommitmentMetadata()
      Gets the metadata for a required commitment.
      Returns:
      metadata for the required commitment
      Compliance:
      mandatory - This method must be implemented.

    • setCommitment

      void setCommitment(long commitment)
      Sets the required commitment percentage (0-100).
      Parameters:
      commitment - the required commitment
      Throws:
      InvalidArgumentException - commitment is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearCommitment

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

    • getTitleMetadata

      Metadata getTitleMetadata()
      Gets the metadata for a title.
      Returns:
      metadata for the title
      Compliance:
      mandatory - This method must be implemented.

    • setTitle

      void setTitle(String title)
      Sets the title.
      Parameters:
      title - the title
      Throws:
      InvalidArgumentException - title is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - title is null
      Compliance:
      mandatory - This method must be implemented.

    • clearTitle

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

    • getSalaryMetadata

      Metadata getSalaryMetadata()
      Gets the metadata for a salary.
      Returns:
      metadata for the salary
      Compliance:
      mandatory - This method must be implemented.

    • setSalary

      void setSalary(Currency salary)
      Sets the salary.
      Parameters:
      salary - the slary
      Throws:
      InvalidArgumentException - salary is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - salary is null
      Compliance:
      mandatory - This method must be implemented.

    • clearLowSalaryRange

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

    • getAppointmentFormRecord

      AppointmentFormRecord getAppointmentFormRecord(Type appointmentRecordType) throws OperationFailedException
      Gets the AppointmentFormRecord interface corresponding to the given appointment record Type .
      Parameters:
      appointmentRecordType - the appointment record type
      Returns:
      the record
      Throws:
      NullArgumentException - appointmentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(appointmentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.