Interface RequestTransaction

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

A RequestTransaction is set of Requests.

  • Method Details

    • getBrokerId

      Id getBrokerId()
      Gets the Id of the broker.
      Returns:
      the broker Id
      Compliance:
      mandatory - This method must be implemented.

    • getBroker

      Broker getBroker() throws OperationFailedException
      Gets the broker.
      Returns:
      the broker
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSubmitDate

      DateTime getSubmitDate()
      Gets the date this transaction was submitted. The submitted date may differ from the effective dates of this provision.
      Returns:
      the transaction submit date
      Compliance:
      mandatory - This method must be implemented.

    • getSubmitterId

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

    • getSubmitter

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

    • getSubmittingAgentId

      Id getSubmittingAgentId()
      Gets the Id of the submitting agent.
      Returns:
      the agent Id
      Compliance:
      mandatory - This method must be implemented.

    • getSubmittingAgent

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

    • getRequestIds

      IdList getRequestIds() throws OperationFailedException
      Gets the Ids of the requests.
      Returns:
      the request Ids
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRequests

      RequestList getRequests() throws OperationFailedException
      Gets the requests.
      Returns:
      the requests
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRequestTransactionRecord

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