OSID - osid.personnel.PositionForm Service Interface Definition

Interface	osid.personnel.PositionForm
Implements	`osid.OsidObjectForm`
	`osid.OsidTemporalForm`
	`osid.OsidSubjugateableForm`
Implemented By	`osid.personnel.batch.PositionBatchForm`
Used By	`osid.personnel.PositionAdminSession`
Description	This is the form for creating and updating `Position` objects. Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `PositionAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getTitleMetadata
Description	Gets the metadata for a title.
Return	`osid.Metadata`		metadata for the title
Compliance	`mandatory`		This method must be implemented.
Method	setTitle
Description	Sets the title.
Parameters	`string`	`title`	the title
Errors	INVALID_ARGUMENT		`title` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`title` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearTitle
Description	Clears the title.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLevelMetadata
Description	Gets the metadata for a level.
Return	`osid.Metadata`		metadata for the level
Compliance	`mandatory`		This method must be implemented.
Method	setLevel
Description	Sets the job level.
Parameters	`osid.id.Id`	`gradeId`	the level
Errors	INVALID_ARGUMENT		`gradeId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`gradeId` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearLevel
Description	Clears the level.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getQualificationsMetadata
Description	Gets the metadata for the qualifications.
Return	`osid.Metadata`		metadata for the qualifications
Compliance	`mandatory`		This method must be implemented.
Method	setQualifications
Description	Sets the position qualifications.
Parameters	`osid.id.Id[]`	`objectivesIds`	the learning objective `Ids`
Errors	INVALID_ARGUMENT		`objectiveIds` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`objectiveIds` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearQualifications
Description	Clears the qualifications.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTargetAppointmentsMetadata
Description	Gets the metadata for a target appointments.
Return	`osid.Metadata`		metadata for the target appointments
Compliance	`mandatory`		This method must be implemented.
Method	setTargetAppointments
Description	Sets the target appointments.
Parameters	`cardinal`	`appointments`	the target appointments
Errors	INVALID_ARGUMENT		`appointments` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearTargetAppointments
Description	Clears the target appointments.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getRequiredCommitmentMetadata
Description	Gets the metadata for a required commitment.
Return	`osid.Metadata`		metadata for the required commitment
Compliance	`mandatory`		This method must be implemented.
Method	setRequiredCommitment
Description	Sets the required commitment percentage (0-100).
Parameters	`cardinal`	`commitment`	the required commitment
Errors	INVALID_ARGUMENT		`commitment` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearRequiredCommitment
Description	Clears the required commitment.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLowSalaryRangeMetadata
Description	Gets the metadata for a low salary range.
Return	`osid.Metadata`		metadata for the low salary range
Compliance	`mandatory`		This method must be implemented.
Method	setLowSalaryRange
Description	Sets the low salary range.
Parameters	`osid.financials.Currency`	`salary`	the low salary range
Errors	INVALID_ARGUMENT		`salary` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`salary` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearLowSalaryRange
Description	Clears the low salary.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getMidpointSalaryRangeMetadata
Description	Gets the metadata for a midpoint salary range.
Return	`osid.Metadata`		metadata for the midpoint salary range
Compliance	`mandatory`		This method must be implemented.
Method	setMidpointSalaryRange
Description	Sets the midpoint salary range.
Parameters	`osid.financials.Currency`	`salary`	the midpoint salary range
Errors	INVALID_ARGUMENT		`salary` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`salary` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearMidpointSalaryRange
Description	Clears the midpoint salary.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getHighSalaryRangeMetadata
Description	Gets the metadata for a high salary range.
Return	`osid.Metadata`		metadata for the high salary range
Compliance	`mandatory`		This method must be implemented.
Method	setHighSalaryRange
Description	Sets the high salary range.
Parameters	`osid.financials.Currency`	`salary`	the high salary range
Errors	INVALID_ARGUMENT		`salary` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`salary` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearHighSalaryRange
Description	Clears the high salary.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCompensationFrequencyMetadata
Description	Gets the metadata for a compensation frequency.
Return	`osid.Metadata`		metadata for the compensation frequency
Compliance	`mandatory`		This method must be implemented.
Method	setCompensationFrequency
Description	Sets the compensation frequency.
Parameters	`osid.calendaring.Duration`	`frequency`	the compensation frequency
Errors	INVALID_ARGUMENT		`frequency` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`frequency` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearCompensationFrequency
Description	Clears the compensation frequency.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getExemptMetadata
Description	Gets the metadata for the exempt flag.
Return	`osid.Metadata`		metadata for the exempt flag
Compliance	`mandatory`		This method must be implemented.
Method	setExempt
Description	Sets the exempt flag.
Parameters	`boolean`	`exempt`	the exempt flag
Errors	INVALID_ARGUMENT		`exempt` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearExempt
Description	Clears the exempt flag.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getBenefitsTypeMetadata
Description	Gets the metadata for a benefits type.
Return	`osid.Metadata`		metadata for the benefits type
Compliance	`mandatory`		This method must be implemented.
Method	setBenefitsType
Description	Sets the benefits type.
Parameters	`osid.type.Type`	`type`	the benefits type
Errors	INVALID_ARGUMENT		`type` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`type` is null
Compliance	`mandatory`		This method must be implemented.
Method	clearBenefitsType
Description	Clears the benefits type.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPositionFormRecord
Description	Gets the `PositionFormRecord` interface corresponding to the given position record `Type`.
Parameters	`osid.type.Type`	`positionRecordType`	the position record type
Return	`osid.personnel.records.PositionFormRecord`		the record
Errors	NULL_ARGUMENT		`positionRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(positionRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.