/**
 *
 * Copyright
 * 2009-2015 Jayway Products AB
 * 2016-2017 Föreningen Sambruk
 *
 * Licensed under AGPL, Version 3.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.gnu.org/licenses/agpl.txt
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package se.streamsource.streamflow.web.application.archival;

import org.qi4j.api.common.UseDefaults;
import org.qi4j.api.configuration.ConfigurationComposite;
import org.qi4j.api.configuration.Enabled;
import org.qi4j.api.property.Property;

/**
 * TODO
 */
public interface ArchivalConfiguration
   extends ConfigurationComposite, Enabled
{
    /**
     * Tells whether the scheduled archival job should be run automatically
     * or if we rely on manual archival.
     * @return
     */
    @UseDefaults
    Property<Boolean> startScheduledArchival();

    /**
     * Amount of cases to process before making a 2 seconds wait.
     * @return
     */
    @UseDefaults
    Property<Integer> modulo();

    /**
     * A crontab schedule string for starting archival.
     *
     * @return
     */
    @UseDefaults
    Property<String> startSchedule();

    /**
     * A crontab schedule string for stopping archival.
     *
     * @return
     */
    @UseDefaults
    Property<String> stopSchedule();

    /**
     * The amount of milliseconds the executing job should sleep between intervals.
     * @return
     */
    @UseDefaults
    Property<Long> sleepInMillis();
}