HistoricRequest (eBus Feed 7.4.0 API)

java.lang.Object
- net.sf.eBus.messages.EMessageObject
- - net.sf.eBus.messages.EMessage
  - - net.sf.eBus.messages.ERequestMessage
    - - net.sf.eBus.feed.historic.HistoricRequest

All Implemented Interfaces:

Serializable
```
@EReplyInfo(replyMessageClasses=HistoricReply.class)
public final class HistoricRequest
extends ERequestMessage
```
Request for historic notification messages based on the given date/time interval. This date/time interval must be in the past (the interval ends before or at the current wall clock time). Historic notifications are returned via an HistoricReply message. Note that the returned notifications may contain PublishStatusEvent messages. This allows the requester to know when notifications are missing due to a down feed state and decide if statistical analysis is possible in the face of missing data.
An example historic notification request creation (note that requests may only be created using a builder instance):
```
final HistoricRequest.Builder builder = HistoricRequest.builder();
final EInterval interval = ...; // See net.sf.eBusx.time.EInterval.
final HistoricRequest request = builder.subject(mSubject)
                                       .timestamp(Instant.now())
                                       .interval(interval)
                                       .build();
```
This request is generally used by EHistoricSubscribeFeed to retrieve past notifications from EHistoricPublishFeed instances.
Author:

Charles W. Rapp

See Also:

HistoricReply, PublishStatusEvent, EHistoricSubscribeFeed, Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class HistoricRequest.Builder
Builder class for HistoricRequest message instances.
- Nested classes/interfaces inherited from class net.sf.eBus.messages.EMessage
  EMessage.MessageType

Field Summary

Fields
Modifier and Type Field Description

EInterval interval
Retrieve historic notification messages over this date/time interval.
- Fields inherited from class net.sf.eBus.messages.EMessage
  MAX_SUBJECT_LENGTH, subject, timestamp

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static HistoricRequest.Builder`	`builder()`	Returns an historic notification request builder instance.
`String`	`toString()`	Returns textual representation of an historic notification message request.

Methods inherited from class net.sf.eBus.messages.EMessage
equals, hashCode, isApplicationMessage, isSystemMessage, key, messageType, timestampAsInstant

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

- Field Detail
  - interval
```
public final EInterval interval
```
    Retrieve historic notification messages over this date/time interval.
- Method Detail
  - toString
```
public String toString()
```
    Returns textual representation of an historic notification message request.
    
    Overrides:
    
    toString in class EMessage
    
    Returns:
    
    request message as text.
  - builder
```
public static HistoricRequest.Builder builder()
```
    Returns an historic notification request builder instance. It is recommended that a new builder instance be used for each historic request meaning builder instances should not be reused.
    
    Returns:
    
    new historic notification request builder instance.