Interface Commitment

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

A Commitment maps a Resource to an Event .

  • Method Details

    • getEventId

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

    • getEvent

      Event getEvent() throws OperationFailedException
      Gets the Event .
      Returns:
      the event
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getResourceId

      Id getResourceId()
      Gets the resource Id .
      Returns:
      a 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.

    • getCommitmentRecord

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