Package de.hybris.platform.outboundsync.job.impl

Interface OutboundSyncJobRegister

  • All Known Implementing Classes:
    DefaultOutboundSyncJobRegister
    public interface OutboundSyncJobRegister
    A registry of currently running outbound sync jobs.

    • Method Detail

      • getNewJob

        @NotNull
@NotNull OutboundSyncJob getNewJob​(@NotNull
                                   @NotNull OutboundSyncCronJobModel jobModel)
        Retrieves new instance of the outbound sync job object for the specified job model. Each subsequent call always returns new job instance. On the other hand, because it always returns a fresh job object instance, it guarantees the previous and possibly stale state of the job is discarded. For this reason, it makes sense to use this method only when it's reliably the first retrieval of the outbound sync job from this register. Otherwise, #getJob should be used.
        Parameters:
        jobModel - job entity model representing the cron job being executed.
        Returns:
        a state aggregator for the specified job model. If a state aggregator has been requested for the job model before, exactly same instance of aggregator is returned for the subsequent calls; otherwise a new instance of the aggregator is created and registered.

      • getJob

        @NotNull
@NotNull OutboundSyncJob getJob​(@NotNull
                                @NotNull OutboundSyncCronJobModel jobModel)
        Retrieves the outbound sync job object corresponding to the specified job model.
        Parameters:
        jobModel - job entity model representing the cron job being executed.
        Returns:
        an outbound sync job for the specified job model. If that job has been requested by same job model before, exactly same instance of the outbound sync job is returned for the subsequent calls; otherwise a new instance of the job is created and registered.

      • getJob

        java.util.Optional<OutboundSyncJob> getJob​(@NotNull
                                           @NotNull PK jobPk)
        Retrieves the outbound sync job object corresponding to the specified job model primary key.
        Parameters:
        jobPk - primary key of the job entity model, for which the aggregator needs to be retrieved.
        Returns:
        an Optional with the outbound sync job for the specified job model primary key. If the job has been requested for the job model before, exactly same instance of the job is returned in the Optional for the subsequent calls; otherwise a new instance of the outbound sync job is created and registered. If the primary key does not correspond to an OutboundSyncCronJobModel, then Optional.empty() is returned.