OSID - osid.resourcing.Availability Service Interface Definition

Interface	osid.resourcing.Availability
Implements	`osid.OsidRelationship`
Used By	`osid.resourcing.AvailabilityAdminSession`
	`osid.resourcing.AvailabilityList`
	`osid.resourcing.AvailabilityLookupSession`
Description	An `Availability` represents a resource's availability for work. A competency may be used to qualify how the resource can be applied to the work. The effective dates of this relationship specify the availability dates for the resource.
Method	getResourceId
Description	Gets the resource `Id`.
Return	`osid.id.Id`		the resource `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getResource
Description	Gets the resource.
Return	`osid.resource.Resource`		the resource
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getJobId
Description	Gets the job `Id`.
Return	`osid.id.Id`		the job `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getJob
Description	Gets the job.
Return	`osid.resourcing.Job`		the job
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isCompetent
Description	Tests if a competency is specified for this availability.
Return	`boolean`		`true` if a competency is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCompetencyId
Description	Gets the competency `Id`.
Return	`osid.id.Id`		the competency `Id`
Errors	ILLEGAL_STATE		`isCompetent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getCompetency
Description	Gets the competency.
Return	`osid.resourcing.Competency`		the competency
Errors	ILLEGAL_STATE		`isCompetent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getPercentage
Description	Gets the percentage availability.
Return	`cardinal`		the percentage availability
Compliance	`mandatory`		This method must be implemented.
Method	getAvailabilityRecord
Description	Gets the availability record corresponding to the given `Availability` record `Type`. This method is used to retrieve an object implementing the requested record. The `availabilityRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(availabilityRecordType)` is `true`.
Parameters	`osid.type.Type`	`availabilityRecordType`	the type of availability record to retrieve
Return	`osid.resourcing.records.AvailabilityRecord`		the availability 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.