OSID Logo
OSID Specifications
personnel package
Version 3.1.0
Interfaceosid.personnel.AppointmentForm
Implementsosid.OsidRelationshipForm
Implemented Byosid.personnel.batch.AppointmentBatchForm
Used Byosid.personnel.AppointmentAdminSession
Description

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.

MethodgetCommitmentMetadata
Description

Gets the metadata for a required commitment.

Returnosid.Metadata metadata for the required commitment
Compliancemandatory This method must be implemented.
MethodsetCommitment
Description

Sets the required commitment percentage (0-100).

Parameterscardinalcommitment the required commitment
ErrorsINVALID_ARGUMENT commitment is invalid
NO_ACCESS Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodclearCommitment
Description

Clears the required commitment.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodgetTitleMetadata
Description

Gets the metadata for a title.

Returnosid.Metadata metadata for the title
Compliancemandatory This method must be implemented.
MethodsetTitle
Description

Sets the title.

Parametersstringtitle the title
ErrorsINVALID_ARGUMENT title is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT title is null
Compliancemandatory This method must be implemented.
MethodclearTitle
Description

Clears the title.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodgetSalaryMetadata
Description

Gets the metadata for a salary.

Returnosid.Metadata metadata for the salary
Compliancemandatory This method must be implemented.
MethodsetSalary
Description

Sets the salary.

Parametersosid.financials.Currencysalary the slary
ErrorsINVALID_ARGUMENT salary is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT salary is null
Compliancemandatory This method must be implemented.
MethodclearLowSalaryRange
Description

Clears the salary.

ErrorsNO_ACCESS Metadata.isRequired() or Metadata.isReadOnly() is true
Compliancemandatory This method must be implemented.
MethodgetAppointmentFormRecord
Description

Gets the AppointmentFormRecord interface corresponding to the given appointment record Type.

Parametersosid.type.TypeappointmentRecordType the appointment record type
Returnosid.personnel.records.AppointmentFormRecord the record
ErrorsNULL_ARGUMENT appointmentRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(appointmentRecordType) is false
Compliancemandatory This method must be implemented.