Interface Availability

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Availability extends OsidRelationship

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 Details

    • getResourceId

      Id getResourceId()
      Gets the resource Id .
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getResource

      Resource getResource() throws OperationFailedException
      Gets the resource.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getJobId

      Id getJobId()
      Gets the job Id .
      Returns:
      the job Id
      Compliance:
      mandatory - This method must be implemented.

    • getJob

      Job getJob() throws OperationFailedException
      Gets the job.
      Returns:
      the job
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isCompetent

      boolean isCompetent()
      Tests if a competency is specified for this availability.
      Returns:
      true if a competency is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCompetencyId

      Id getCompetencyId()
      Gets the competency Id .
      Returns:
      the competency Id
      Throws:
      IllegalStateException - isCompetent() is false
      Compliance:
      mandatory - This method must be implemented.

    • getCompetency

      Competency getCompetency() throws OperationFailedException
      Gets the competency.
      Returns:
      the competency
      Throws:
      IllegalStateException - isCompetent() is false
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getPercentage

      long getPercentage()
      Gets the percentage availability.
      Returns:
      the percentage availability
      Compliance:
      mandatory - This method must be implemented.

    • getAvailabilityRecord

      AvailabilityRecord getAvailabilityRecord(Type availabilityRecordType) throws OperationFailedException
      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:
      availabilityRecordType - the type of availability record to retrieve
      Returns:
      the availability record
      Throws:
      NullArgumentException - availabilityRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(availabilityRecordType) is false
      Compliance:
      mandatory - This method must be implemented.