/*
 * Copyright Red Hat, Inc. and/or its affiliates
 * and other contributors as indicated by the @author tags and
 * the COPYRIGHT.txt file distributed with this work.
 *
 * 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.komodo.core.repository;

import org.komodo.core.internal.repository.KSequencers;
import org.komodo.spi.repository.UnitOfWorkDelegate;


/**
 * Listener for {@link KSequencers} events
 */
public interface KSequencerListener {

    /**
     * @return unique id of the events to listen for. This id should match
     *                the id
     */
    String id();

    /**
     * @return the session associated with the sequence listener
     */
    UnitOfWorkDelegate session();

    /**
     * Will be called when all sequencers have been executed
     */
    void sequencingCompleted();

    /**
     * Will be called if the sequencers encounter an error
     *
     * @param exception error encountered
     */
    void sequencingError(Exception exception);

    /**
     * Called to abort the listener operation if an error has occurred in
     * the parent transaction
     */
    void abort();
}
