/*
 *  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.applib.events.lifecycle;

/**
 * Broadcast when an entity is about to be updated in the database, usually
 * as the result of the ORM dirty tracking mechanisms.
 *
 * @see ObjectUpdatedEvent
 *
 * @since 1.x {@index}
 */
public abstract class ObjectUpdatingEvent<S> extends AbstractLifecycleEvent<S> {

    /**
     * This class is the default for the
     * {@link org.apache.causeway.applib.annotation.DomainObject#updatingLifecycleEvent()} annotation attribute.  Whether this
     * raises an event or not depends upon the <tt>causeway.core.meta-model.annotation.domain-object.updating-lifecycle-event.post-for-default</tt>
     * configuration property.
     */
    public static class Default extends ObjectUpdatingEvent<Object> {}

    /**
     * Convenience class to use indicating that an event should <i>not</i> be posted (irrespective of the configuration
     * property setting for the {@link Default} event.
     */
    public static class Noop extends ObjectUpdatingEvent<Object> {}

    /**
     * Convenience class meaning that an event <i>should</i> be posted (irrespective of the configuration
     * property setting for the {@link Default} event..
     */
    public static class Doop extends ObjectUpdatingEvent<Object> {}

    public ObjectUpdatingEvent() {
    }

    public ObjectUpdatingEvent(final S source) {
        super(source);
    }

}
