/*
 * Autopsy Forensic Browser
 *
 * Copyright 2014 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.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.apache.org/licenses/LICENSE-2.0
 *
 * 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 org.sleuthkit.autopsy.externalresults;

import java.util.List;
import org.sleuthkit.autopsy.coreutils.ErrorInfo;

/**
 * Interface for parsers that convert some representation of results data (e.g.,
 * artifacts, derived files, reports) generated by a process external to Autopsy
 * into a form ready for import into Autopsy.
 */
public interface ExternalResultsParser {

    /**
     * Converts some representation of results data generated by a process
     * external to Autopsy and supplied to the parser via its constructor into a
     * form ready for import into Autopsy.
     *
     * @return External results data in a form ready for import into Autopsy.
     */
    ExternalResults parse();

    /**
     * Gets error information describing any errors encountered while parsing
     * the input results representation.
     *
     * @return A collection of error messages, possibly empty. The error
     *         messages are already logged but are provided to allow the caller
     *         to provide additional user feedback via the Autopsy user
     *         interface.
     */
    List<ErrorInfo> getErrorInfo();
}