OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.AppointmentForm
Implementsosid.OsidRelationshipForm
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.Metadatametadata for the required commitment
CompliancemandatoryThis method must be implemented.
MethodsetCommitment
Description

Sets the required commitment percentage (0-100).

Parameterscardinalcommitmentthe required commitment
ErrorsINVALID_ARGUMENT commitment is invalid
NO_ACCESS Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodclearCommitment
Description

Clears the required commitment.

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

Gets the metadata for a title.

Returnosid.Metadatametadata for the title
CompliancemandatoryThis method must be implemented.
MethodsetTitle
Description

Sets the title.

Parametersstringtitlethe title
ErrorsINVALID_ARGUMENT title is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT title is null
CompliancemandatoryThis method must be implemented.
MethodclearTitle
Description

Clears the title.

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

Gets the metadata for a salary.

Returnosid.Metadatametadata for the salary
CompliancemandatoryThis method must be implemented.
MethodsetSalary
Description

Sets the salary.

Parametersosid.financials.Currencysalarythe slary
ErrorsINVALID_ARGUMENT salary is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT salary is null
CompliancemandatoryThis method must be implemented.
MethodclearLowSalaryRange
Description

Clears the salary.

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

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

Parametersosid.type.TypeappointmentRecordTypethe appointment record type
Returnosid.personnel.records.AppointmentFormRecordthe record
ErrorsNULL_ARGUMENT appointmentRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(appointmentRecordType) is false
CompliancemandatoryThis method must be implemented.