org.pepsoft.worldpainter.PrivateContext Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of WPGUI Show documentation

There is a newer version: 2.23.2

package org.pepsoft.worldpainter;

import org.pepsoft.worldpainter.vo.UsageVO;

/**
 * Created by pepijn on 8-2-2015.
 */
public interface PrivateContext {
    /**
     * Initiate a check for updates. May show popups and exit the program to
     * install a new version at its option.
     */
    void checkForUpdates();

    /**
     * Submit usage data to the server, in either a blocking fashion or in the
     * background. Upon successful submission the submitted events should be
     * removed from the persisten event log.
     *
     * @param usageData The usage data to submit.
     * @param blocking  When {@code true} the method should block until finished
     *                  and throw a runtime exception in case of error. When
     *                  {@code false} the method should return immediately and
     *                  perform the submission in the background, logging an
     *                  error in case of failure.
     */
    void submitUsageData(UsageVO usageData, boolean blocking);
}