com.adobe.cq.scheduled.exporter.ExportConfig Maven / Gradle / Ivy

/*************************************************************************
 *
 * ADOBE CONFIDENTIAL
 * __________________
 *
 *  Copyright 2012 Adobe Systems Incorporated
 *  All Rights Reserved.
 *
 * NOTICE:  All information contained herein is, and remains
 * the property of Adobe Systems Incorporated and its suppliers,
 * if any.  The intellectual and technical concepts contained
 * herein are proprietary to Adobe Systems Incorporated and its
 * suppliers and may be covered by U.S. and Foreign Patents,
 * patents in process, and are protected by trade secret or copyright law.
 * Dissemination of this information or reproduction of this material
 * is strictly forbidden unless prior written permission is obtained
 * from Adobe Systems Incorporated.
 **************************************************************************/
package com.adobe.cq.scheduled.exporter;

/**
 * The ExportConfig interface represents configurations managed by
 * the {@link ScheduledExporter} service.
 */
public interface ExportConfig {

    /**
     * The scheduler expression of this configuration.
     * 
     * @return Scheduler expression string
     */
    String getSchedulerExpression();

    /**
     * Returns the identification path of this configuration.
     * 
     * @return Identification path
     */
    String getPath();

    /**
     * Returns the type of this exporter. The type is a String representing the
     * {@link Exporter} implementation responsible for handling the export.
     * 
     * @return Importer type
     */
    String getType();

    /**
     * Returns the data source path. This is given to the {@link Exporter}
     * handling the {@link #getType()} of this configuration to acquire the
     * data.
     * 
     * @return Data source path
     */
    String getSource();

    /**
     * The enable state for the configuration.
     * 
     * @return true if enabled, false otherwise.
     */
    boolean isEnabled();

}