webloader/service/src/main/java/org/apache/sling/samples/webloader/WebloaderJobStatus.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.apache.sling.samples.webloader;

/** Provides status information about a Webloader job */
public interface WebloaderJobStatus {
    
    /** Is this job still running? */
    boolean isRunning();
    
    /** @return the error cause if the job aborted */ 
    Throwable getError();
    
    /** Get the "main" status info, like "loading document foo.pdf"... */
    String getStatusInfo();
    
    /** Get status details, like "19234 bytes loaded" */
    String getStatusDetails();
    
    /** How many documents loaded by this job already? */
    int getNumberOfDocumentsLoaded();
}