enterprises.orbital.evekit.model.SynchronizationHandler Maven / Gradle / Ivy

Go to download

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

Handles periodic synchronization of account data

The newest version!

package enterprises.orbital.evekit.model;

import enterprises.orbital.evekit.account.SynchronizedEveAccount;

import java.io.IOException;

public interface SynchronizationHandler {

  /**
   * Return the currently active sync tracker for this account, or null if there is no active sync tracker.
   * 
   * @param owner
   *          the account on whose behalf the tracker is sync'ing.
   * @return the currently active and unfinished sync tracker for the owner, or null if there is no active sync tracker.
   */
  public A getCurrentTracker(
                             SynchronizedEveAccount owner);

  /**
   * Return the existing container of a synchronized account, or null if no container exists.
   * 
   * @param owner
   *          the account which owns the container.
   * @return the existing container for this account, or null if no container exists.
   */
  public C getExistingContainer(
                                SynchronizedEveAccount owner);

  public boolean isRefreshed(
                             A tracker);

  public void updateStatus(
                           A tracker,
                           SyncTracker.SyncState status,
                           String detail) throws IOException;

  public boolean prereqSatisfied(
                                 A tracker);

  public void updateExpiry(
                           C container,
                           long expiry) throws IOException;

  public long getExpiryTime(
                            C container);

  public boolean commit(
                        long time,
                        A tracker,
                        C container,
                        SynchronizedEveAccount accountKey,
                        CachedData item) throws IOException;

}