Class SyncEventsRequestDTO

java.lang.Object
de.aeb.xnsg.foundation.bf.AbstractRequestDTO
de.aeb.xnsg.foundation.bf.sync.SyncEventsRequestDTO

public class SyncEventsRequestDTO extends AbstractRequestDTO
Request DTO for synchronizing events.
  • Field Details

    • syncId

      public String syncId
      Synchronization ID for delta-transmission.

      In calls to ISyncBF.synchronizeEvents(SyncEventsRequestDTO):
      Pass this field with the value returned in SyncEventsResponseDTO.syncId with the last call to ISyncBF.synchronizeEvents(SyncEventsRequestDTO).
      For initializing of delta-transmissions pass simply null.

      In calls to ISyncBF.getNotAcknowledgedEvents(SyncEventsRequestDTO) this field is not used.

      length=20

    • businessObjectType

      public String 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

      public Integer ageInDays
      Only for the initializing of delta-transmissions (if syncId == null)

      Start the initializing of delta transmission with with this age. Older events will not be synchronized.

    • blockSize

      public Integer blockSize
      For defining the block size. Can be null. If empty the default block size of 100 is used.
    • returnTotalCount

      public Boolean returnTotalCount
      If true, the total number of events is returned in field SyncEventsResponseDTO.totalCount.

      Note that requiring the total number of events may lead to substantial performance penalties in the service.

  • Constructor Details

    • SyncEventsRequestDTO

      public SyncEventsRequestDTO()