engine/src/main/java/org/apache/sling/bgservlets/JobProgressInfo.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.bgservlets;

import java.util.Date;

/** Provides Job progress information */
public interface JobProgressInfo {
    
    /** Return the job's ETA if available.
     *  @return null if the job didn't provide an ETA, or if 
     *      it is done.
     */
    Date getEstimatedCompletionTime();
    
    /** Return a single line of progress information */
    String getProgressMessage();
}