HistoryOptions (Crux Javadoc)

java.lang.Object
- crux.api.HistoryOptions

public final class HistoryOptions
extends Object

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class HistoryOptions.SortOrder

Nested Classes
Modifier and Type	Class and Description
`static class`	`HistoryOptions.SortOrder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static HistoryOptions`	`create(HistoryOptions.SortOrder sortOrder)`
`HistoryOptions`	`endTransaction(TransactionInstant endTransaction)` Sets the ending transaction.
`HistoryOptions`	`endTransactionTime(Date endTransactionTime)` Sets the ending transaction time.
`HistoryOptions`	`endValidTime(Date endValidTime)` Sets the end valid time.
`TransactionInstant`	`getEndTransaction()`
`Date`	`getEndValidTime()`
`HistoryOptions.SortOrder`	`getSortOrder()`
`Keyword`	`getSortOrderKey()`
`TransactionInstant`	`getStartTransaction()`
`Date`	`getStartValidTime()`
`boolean`	`isWithCorrections()`
`boolean`	`isWithDocs()`
`HistoryOptions`	`sortOrder(HistoryOptions.SortOrder sortOrder)`
`HistoryOptions`	`startTransaction(TransactionInstant startTransaction)` Sets the starting transaction.
`HistoryOptions`	`startTransactionTime(Date startTransactionTime)` Sets the starting transaction time.
`HistoryOptions`	`startValidTime(Date startValidTime)` Sets the starting valid time.
`IPersistentMap`	`toMap()` Not intended for public use, may be removed.
`HistoryOptions`	`withCorrections(boolean withCorrections)` Specifies whether to return bitemporal corrections in the history response.
`HistoryOptions`	`withDocs(boolean withDocs)` Specifies whether to return documents in the history response.

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

- Method Detail
  - create
```
public static HistoryOptions create(HistoryOptions.SortOrder sortOrder)
```
  - sortOrder
```
public HistoryOptions sortOrder(HistoryOptions.SortOrder sortOrder)
```
  - withCorrections
```
public HistoryOptions withCorrections(boolean withCorrections)
```
    Specifies whether to return bitemporal corrections in the history response. If this is set to `true`, corrections will be returned within the sequence, sorted first by valid-time, then tx-id.
  - withDocs
```
public HistoryOptions withDocs(boolean withDocs)
```
    Specifies whether to return documents in the history response. If this is set to `true`, documents will be included under the `:crux.db/doc` key.
  - startValidTime
```
public HistoryOptions startValidTime(Date startValidTime)
```
    Sets the starting valid time. The history response will include entries starting at this valid time (inclusive).
  - startTransaction
```
public HistoryOptions startTransaction(TransactionInstant startTransaction)
```
    Sets the starting transaction. The history response will include entries starting at this transaction (inclusive).
  - startTransactionTime
```
public HistoryOptions startTransactionTime(Date startTransactionTime)
```
    Sets the starting transaction time. The history response will include entries starting at this transaction (inclusive).
  - endValidTime
```
public HistoryOptions endValidTime(Date endValidTime)
```
    Sets the end valid time. The history response will include entries up to this valid time (exclusive).
  - endTransaction
```
public HistoryOptions endTransaction(TransactionInstant endTransaction)
```
    Sets the ending transaction. The history response will include entries up to this transaction (exclusive).
  - endTransactionTime
```
public HistoryOptions endTransactionTime(Date endTransactionTime)
```
    Sets the ending transaction time. The history response will include entries up to this transaction (exclusive).
  - getSortOrder
```
public HistoryOptions.SortOrder getSortOrder()
```
  - isWithCorrections
```
public boolean isWithCorrections()
```
  - isWithDocs
```
public boolean isWithDocs()
```
  - getStartValidTime
```
public Date getStartValidTime()
```
  - getStartTransaction
```
public TransactionInstant getStartTransaction()
```
  - getEndValidTime
```
public Date getEndValidTime()
```
  - getEndTransaction
```
public TransactionInstant getEndTransaction()
```
  - getSortOrderKey
```
public Keyword getSortOrderKey()
```
  - toMap
```
public IPersistentMap toMap()
```
    Not intended for public use, may be removed.

Class HistoryOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

create

sortOrder

withCorrections

withDocs

startValidTime

startTransaction

startTransactionTime

endValidTime

endTransaction

endTransactionTime

getSortOrder

isWithCorrections

isWithDocs

getStartValidTime

getStartTransaction

getEndValidTime

getEndTransaction

getSortOrderKey

toMap