OSID - osid.resourcing.AvailabilityForm Service Interface Definition

Interface	osid.resourcing.AvailabilityForm
Implements	`osid.OsidRelationshipForm`
Implemented By	`osid.resourcing.batch.AvailabilityBatchForm`
Used By	`osid.resourcing.AvailabilityAdminSession`
Description	This is the form for creating and updating `Availabilities` . Like all `OsidForm` objects, various data elements may be set here for use in the create and update methods in the `AvailabilityAdminSession` . For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getCompetencyMetadata
Description	Gets the metadata for the competency.
Return	`osid.Metadata`		metadata for the competency
Compliance	`mandatory`		This method must be implemented.
Method	setCompetency
Description	Sets the competency.
Parameters	`osid.id.Id`	`competencyId`	the new competency
Errors	INVALID_ARGUMENT		`competencyId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`competencyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCompetency
Description	Removes the competency.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getPercentageMetadata
Description	Gets the metadata for the percentage availability.
Return	`osid.Metadata`		metadata for the percentage availability
Compliance	`mandatory`		This method must be implemented.
Method	setPercentage
Description	Sets the percent availability.
Parameters	`cardinal`	`availability`	the new percentage vaailability
Errors	INVALID_ARGUMENT		`availability` is invalid
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearPercentage
Description	Removes the percentage availability.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityFormRecord
Description	Gets the `AvailabilityFormRecord` corresponding to the given availability record `Type` .
Parameters	`osid.type.Type`	`availabilityRecordType`	an availability record type
Return	`osid.resourcing.records.AvailabilityFormRecord`		the availability form record
Errors	NULL_ARGUMENT		`availabilityRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(availabilityRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.