/*
 *  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.causeway.core.metamodel.services.publishing;

import org.apache.causeway.applib.services.command.Command;
import org.apache.causeway.applib.services.publishing.spi.CommandSubscriber;

import org.jspecify.annotations.NonNull;

/**
 * Notifies {@link CommandSubscriber}s.
 *
 * @since 2.0 {@index}
 */
public interface CommandPublisher {

    /**
     * Notifies all {@link CommandSubscriber}s (through {@link CommandSubscriber#onReady(Command)}) that the
     * {@link Command} has been created/is ready for execution
     */
    void ready(@NonNull Command command);

    /**
     * Notifies all {@link CommandSubscriber}s (through {@link CommandSubscriber#onStarted(Command)}) that the
     * {@link Command} has started.
     */
    void start(@NonNull Command command);

    /**
     * Notifies all {@link CommandSubscriber}s (through {@link CommandSubscriber#onCompleted(Command)}) that the
     * {@link Command} has completed.
     */
    void complete(@NonNull Command command);

}
