Package de.aeb.xnsg.foundation.bf.sync
Class SyncEventsRequestDTO
java.lang.Object
de.aeb.xnsg.foundation.bf.AbstractRequestDTO
de.aeb.xnsg.foundation.bf.sync.SyncEventsRequestDTO
Request DTO for synchronizing events.
-
Field Summary
FieldsModifier and TypeFieldDescriptionOnly for the initializing of delta-transmissions (ifsyncId
== null)For defining the block size.Optional parameter to restrict the events to be polled to that business object type.Iftrue
, the total number of events is returned in fieldSyncEventsResponseDTO.totalCount
.Synchronization ID for delta-transmission.Fields inherited from class de.aeb.xnsg.foundation.bf.AbstractRequestDTO
clientIdentCode, clientSystemId, resultLanguageIsoCodes, userName
-
Constructor Summary
Constructors -
Method Summary
-
Field Details
-
syncId
Synchronization ID for delta-transmission.In calls to
ISyncBF.synchronizeEvents(SyncEventsRequestDTO)
:
Pass this field with the value returned inSyncEventsResponseDTO.syncId
with the last call toISyncBF.synchronizeEvents(SyncEventsRequestDTO)
.
For initializing of delta-transmissions pass simply null.ISyncBF.getNotAcknowledgedEvents(SyncEventsRequestDTO)
this field is not used.
length=20
-
businessObjectType
Optional parameter to restrict the events to be polled to that business object type. May be null to get all subscribed events of all business object types.
Since XNSG 4.0, Nov. FP, 2017
length=20 -
ageInDays
Only for the initializing of delta-transmissions (ifsyncId
== null)Start the initializing of delta transmission with with this age. Older events will not be synchronized.
-
blockSize
For defining the block size. Can be null. If empty the default block size of 100 is used. -
returnTotalCount
Iftrue
, the total number of events is returned in fieldSyncEventsResponseDTO.totalCount
.Note that requiring the total number of events may lead to substantial performance penalties in the service.
-
-
Constructor Details
-
SyncEventsRequestDTO
public SyncEventsRequestDTO()
-