org.xwiki.job.event.status.JobProgressManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of xwiki-commons-job-api Show documentation
XWiki Commons - Job - API
There is a newer version: 16.10.0-rc-1
Show newest version
/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.job.event.status;

import java.util.concurrent.Callable;

import org.xwiki.component.annotation.Role;
import org.xwiki.logging.Message;

/**
 * Helper to manipulate current progress.
 *
 * @version $Id: 7c78f6c4d5b7487a2061deab9834f0bb50cb5265 $
 * @since 6.1M1
 */
@Role
public interface JobProgressManager
{
    /**
     * Push new progression level with unknown number of steps.
     *
     * @param source the source to send with the event
     */
    void pushLevelProgress(Object source);

    /**
     * Push new progression level.
     *
     * @param steps number of steps in this new level
     * @param source the source to send with the event
     */
    void pushLevelProgress(int steps, Object source);

    /**
     * Close the current step and start a new one.
     *
     * @param source the source to send with the event
     * @deprecated since 7.1M2, use {@link #startStep(Object)} instead
     */
    @Deprecated
    void stepPropress(Object source);

    /**
     * Close the current step if any and start a new one with provided name.
     *
     * @param source the source to send with the event
     * @since 7.1M2
     */
    void startStep(Object source);

    /**
     * Close the current step if any and start a new one with provided name.
     * 
     * @param source the source to send with the event
     * @param name the name associated to the next step
     * @since 7.1M2
     */
    void startStep(Object source, String name);

    /**
     * Close the current step if any and start a new one with provided name.
     * 
     * @param source the source to send with the event
     * @param translationKey the key used to find the translation of the step message
     * @param message the default message associated to the step
     * @param arguments the arguments to insert in the step message
     * @since 7.1M2
     */
    void startStep(Object source, String translationKey, String message, Object... arguments);

    /**
     * Close the current step if any and start a new one with provided name.
     * 
     * @param source the source to send with the event
     * @param message the message associated to the next step
     * @since 7.1M2
     */
    void startStep(Object source, Message message);

    /**
     * Close the current step.
     *
     * @param source the source to send with the event
     * @since 7.1M2
     */
    void endStep(Object source);

    /**
     * Pop current progression level.
     *
     * @param source the source to send with the event
     */
    void popLevelProgress(Object source);

    /**
     * Automatically push and pop progression level with unknown number of steps around passed task.
     *
     * @param  the return type
     * @param task the task to execute
     * @param source the source to send with the event
     * @return computed result
     * @throws Exception if unable to compute a result
     * @since 7.1M1
     */
     T call(Callable task, Object source) throws Exception;

    /**
     * Automatically push and pop progression level around passed task.
     *
     * @param  the return type
     * @param task the task to execute
     * @param steps number of steps in this new level
     * @param source the source to send with the event
     * @return computed result
     * @throws Exception if unable to compute a result
     * @since 7.1M1
     */
     T call(Callable task, int steps, Object source) throws Exception;
}