DataSource.java

package dk.statsbiblioteket.medieplatform.autonomous.processmonitor.datasources;

import dk.statsbiblioteket.medieplatform.autonomous.Batch;
import dk.statsbiblioteket.medieplatform.autonomous.Event;
import dk.statsbiblioteket.medieplatform.autonomous.NotFoundException;

import java.util.List;
import java.util.Map;

/**
 * Interface the the process Monitor data sources. Implementations of this class must have a no-args constructor. All
 * properties must be set by getters and setters.
 */
public interface DataSource {


    /**
     * Get all batches matched by the filters.
     *
     * @param includeDetails should the field "details" be set on the events. This can be an expensive operation, if
     *                       many batches are returned
     * @param filters        the map of filters. Name/value pairs. Can be null, if no filters
     *
     * @return a List of Batch objects. If no batch objects are found, returns an empty list
     * @throws NotWorkingProperlyException If the datasource does not function right now
     */
    List<Batch> getBatches(boolean includeDetails, Map<String, String> filters) throws NotWorkingProperlyException;

    /**
     * Get information about a specific batch
     *
     * @param batchID         the id of the specific batch
     * @param roundTripNumber the round trip number of the specific batch
     * @param includeDetails  should the field "details" be set on the events.
     *
     * @return the Batch object
     * @throws dk.statsbiblioteket.medieplatform.autonomous.NotFoundException
     *                                     If no batch with this ID is found
     * @throws NotWorkingProperlyException If the datasource does not function right now
     */
    Batch getBatch(String batchID, Integer roundTripNumber, boolean includeDetails) throws
                                                                                    NotFoundException,
                                                                                    NotWorkingProperlyException;

    /**
     * Get information about the specific event on the specific batch
     *
     * @param batchID         the batch id
     * @param roundTripNumber the round trip number of the specific batch
     * @param eventID         the event id
     * @param includeDetails  should the field "details" be set on the event.
     *
     * @return the Specific event
     * @throws NotFoundException           if the batch is not found, or the batch does not have an event by this name
     * @throws NotWorkingProperlyException If the datasource does not function right now
     */
    Event getBatchEvent(String batchID, Integer roundTripNumber, String eventID, boolean includeDetails) throws
                                                                                                         NotFoundException,
                                                                                                         NotWorkingProperlyException;

}