ScoTransaction 6.1.0 API

All Implemented Interfaces:


public interface ScoTransaction<T extends AbstractSetResponse>

Definition of an SDC transaction to track incoming operation invoked report parts.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`abstract long`	`getTransactionId()`	Gets the transaction id.
`abstract List<Pair<OperationInvokedReport.ReportPart, MdibVersion>>`	`getReports()`	Gets all reports received so far.
`abstract T`	`getResponse()`	Gets set response message.
`abstract List<Pair<OperationInvokedReport.ReportPart, MdibVersion>>`	`waitForFinalReport(Duration waitTime)`	Starts waiting for a final report.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getTransactionId
```
 abstract long getTransactionId()
```
    Gets the transaction id.
    Shortcut of accessing getTransactionId() of getResponse.
    
    Returns:
    
    the transaction id of this ScoTransactionImpl.
  - getReports
```
 abstract List<Pair<OperationInvokedReport.ReportPart, MdibVersion>> getReports()
```
    Gets all reports received so far.
    
    Returns:
    
    Snapshot of received reports and their respective {#MdibVersion} as a copy.
  - getResponse
```
 abstract T getResponse()
```
    Gets set response message.
    
    Returns:
    
    a copy of the set response message of this ScoTransactionImpl.
  - waitForFinalReport
```
 abstract List<Pair<OperationInvokedReport.ReportPart, MdibVersion>> waitForFinalReport(Duration waitTime)
```
    Starts waiting for a final report.
    A report is final if isFinalReport holds true.
    
    Parameters:
    
    waitTime - maximum wait time until this function returns.
    
    Returns:
    
    a list that holds all reports and their respective {#MdibVersion}, including the final one or an empty list if no final report has been received.