Package de.aeb.xnsg.foundation.bf.sync

Class SyncEventsResponseDTO

java.lang.Object

de.aeb.xnsg.foundation.bf.AbstractResponseDTO

de.aeb.xnsg.foundation.bf.sync.SyncEventsResponseDTO

public class SyncEventsResponseDTO
extends AbstractResponseDTO

Response DTO for synchronizing events.

Field Summary

Fields

Modifier and Type	Field	Description
SyncEventDTO[]	events	The resulting events, matching the requested parameters.
Boolean	isComplete	True, if the synchronization is complete and currently no further events are available.
String	syncId	Synchronization ID for delta-transmission.
BigInteger	totalCount	The total count of available events.

Fields inherited from class de.aeb.xnsg.foundation.bf.AbstractResponseDTO

EMPTY_MANDATORY_FIELD, hasErrors, hasOnlyRetryableErrors, hasWarnings, I18N_WARNING, INTERNAL_SERVER_ERROR, INVALID_DATA_ERROR, INVALID_DATA_WARNING, LOCK_ERROR, messages

Constructor Summary

Constructors

Constructor	Description
SyncEventsResponseDTO()

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

syncId

public String syncId

Synchronization ID for delta-transmission.

Use this syncId in subsequent calls to ISyncBF.synchronizeEvents(SyncEventsRequestDTO) to enable delta-transmission of changes.

However, this syncId may be null if no events are found an the field events is an empty array. In this case use the last NOT NULL syncId returned in this field for subsequent calls to ISyncBF.synchronizeEvents(SyncEventsRequestDTO).

length=20

isComplete

public Boolean isComplete

True, if the synchronization is complete and currently no further events are available. False if not.

Because a maximum of 100 events are returned with one call of ISyncBF.synchronizeEvents(SyncEventsRequestDTO), the result may be incomplete.

totalCount

public BigInteger totalCount

The total count of available events. It is only returned if SyncEventsRequestDTO.returnTotalCount is set.

events

public SyncEventDTO[] events

The resulting events, matching the requested parameters.

A maximum number of 100 events are transmitted per call.

To get ALL events make repeated calls of ISyncBF.synchronizeEvents(SyncEventsRequestDTO), always passing the last returned syncId in the next call with SyncEventsRequestDTO.syncId.

Constructor Details

SyncEventsResponseDTO

public SyncEventsResponseDTO()