package fedora.services.oaiprovider;

import java.util.Date;
import java.util.Iterator;
import java.util.Properties;

import proai.MetadataFormat;
import proai.SetInfo;
import proai.driver.RemoteIterator;
import fedora.client.FedoraClient;

/**
 * Interface for language-specific query handlers to the Fedora Resource Index.
 * 
 * @author Edwin Shin
 */
public interface QueryFactory {

    public void init(FedoraClient client,
                     FedoraClient queryClient,
                     Properties props);

    /**
     * Queries the Fedora Resource Index for the latest last-modified date of
     * all disseminations that act as metadata for the OAI provider.
     * 
     * @param fedoraMetadataFormats
     *        the list of all FedoraMetadataFormats
     * @return date of the latest record
     */
    public Date latestRecordDate(Iterator<? extends MetadataFormat> fedoraMetadataFormats);

    /**
     * @return a RemoteIterator of proai.SetInfo objects
     */
    public RemoteIterator<SetInfo> listSetInfo(InvocationSpec setInfoSpec);

    /**
     * @param from
     *        the date (inclusive) of the earliest record to return. Null
     *        indicates no lower bound.
     * @param until
     *        the date (inclusive). Null indicates no upper bound.
     * @param mdPrefixDissType
     *        the dissemination type for a given metadata prefix.
     * @param mdPrefixAboutDissType
     * @return a RemoteIterator of proai.Record objects
     */
    public RemoteIterator<FedoraRecord> listRecords(Date from,
                                                    Date until,
                                                    FedoraMetadataFormat format);
}