Interface ProvisionReturn

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

A ProvisionReturn captures data related to the return of a provision.

  • Method Details

    • getReturnDate

      DateTime getReturnDate()
      Gets the date returned. The return date is the effective end date of the provision when the return is processed.
      Returns:
      the date returned
      Compliance:
      mandatory - This method must be implemented.

    • getReturnerId

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

    • getReturner

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

    • getReturningAgentId

      Id getReturningAgentId()
      Gets the Id of the returning agent.
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getReturningAgent

      Agent getReturningAgent() throws OperationFailedException
      Gets the returning agent.
      Returns:
      the agent
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getProvisionReturnRecord

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