Interface Appointment

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Appointment extends OsidRelationship

An Appointment relates a Position to a Position .

  • Method Details

    • getPersonId

      Id getPersonId()
      Gets the Id of the person.
      Returns:
      the person Id
      Compliance:
      mandatory - This method must be implemented.

    • getPerson

      Person getPerson() throws OperationFailedException
      Gets the person in this appointment.
      Returns:
      the Person
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPositionId

      Id getPositionId()
      Gets the Id of the position in this appointment.
      Returns:
      the Position Id
      Compliance:
      mandatory - This method must be implemented.

    • getPosition

      Position getPosition() throws OperationFailedException
      Gets the position in this appointment.
      Returns:
      the Position
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getCommitment

      long getCommitment()
      Gets the percentage commitment (0-100).
      Returns:
      the percentage commitment
      Compliance:
      mandatory - This method must be implemented.

    • getTitle

      DisplayText getTitle()
      Gets the title for this appointment.
      Returns:
      the title
      Compliance:
      mandatory - This method must be implemented.

    • hasSalary

      boolean hasSalary()
      Tests if a salary is available.
      Returns:
      true if a salary is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSalary

      Currency getSalary()
      Gets the salary.
      Returns:
      the slaary
      Throws:
      IllegalStateException - hasSalary() is false
      Compliance:
      mandatory - This method must be implemented.

    • getSalaryBasis

      long getSalaryBasis()
      Gets the basis in number of months per year.
      Returns:
      the number of months
      Throws:
      IllegalStateException - hasSalary() is false
      Compliance:
      mandatory - This method must be implemented.

    • getAppointmentRecord

      AppointmentRecord getAppointmentRecord(Type appointmentRecordType) throws OperationFailedException
      Gets the record corresponding to the given Appointment record Type . This method is used to retrieve an object implementing the requested record. The appointmentRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(appointmentRecordType) is true .
      Parameters:
      appointmentRecordType - the type of appointment record to retrieve
      Returns:
      the appointment record
      Throws:
      NullArgumentException - appointmentRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(appointmentRecordType) is false
      Compliance:
      mandatory - This method must be implemented.