Interface Work

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, Subjugateable
public interface Work extends OsidObject, Subjugateable

Work is an instance of a job and may require competence.

  • Method Details

    • getJobId

      Id getJobId()
      Gets the Id of the job of which this work is a part.
      Returns:
      the job Id
      Compliance:
      mandatory - This method must be implemented.

    • getJob

      Job getJob() throws OperationFailedException
      Gets the job of which this work is a part.
      Returns:
      the job
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • needsCompetence

      boolean needsCompetence()
      Tests if specific competencies are needed for this work.
      Returns:
      true if competency if specified, false if incompetence will do
      Compliance:
      mandatory - This method must be implemented.

    • getCompetencyIds

      IdList getCompetencyIds()
      Gets the Ids of the competencies.
      Returns:
      the competency Ids
      Throws:
      IllegalStateException - needsCompetence() is false
      Compliance:
      mandatory - This method must be implemented.

    • getCompetencies

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

    • getCreatedDate

      DateTime getCreatedDate()
      Gets the date this work was created.
      Returns:
      the created date
      Compliance:
      mandatory - This method must be implemented.

    • isComplete

      boolean isComplete()
      Tests if this work has been completed.
      Returns:
      true if this work is complete, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getCompletionDate

      DateTime getCompletionDate()
      Gets the completion date.
      Returns:
      the completion date
      Throws:
      IllegalStateException - isComplete() is false
      Compliance:
      mandatory - This method must be implemented.

    • getWorkRecord

      WorkRecord getWorkRecord(Type workRecordType) throws OperationFailedException
      Gets the work record corresponding to the given Work record Type .This method is used to retrieve an object implementing the requested record. The workRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(workRecordType) is true .
      Parameters:
      workRecordType - the type of work record to retrieve
      Returns:
      the work record
      Throws:
      NullArgumentException - workRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(workRecordType) is false
      Compliance:
      mandatory - This method must be implemented.