001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *        http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 */
019
020package org.apache.isis.core.metamodel.spec;
021
022import org.apache.isis.core.metamodel.adapter.ObjectAdapter;
023
024public interface Dirtiable {
025
026    /**
027     * Clear the dirty flag so that a call to <tt>isDirty()</tt>, and before
028     * <tt>markDirty()</tt> is called, will return false;
029     * 
030     * @see #isDirty(ObjectAdapter)
031     * @see #markDirty(ObjectAdapter)
032     */
033    void clearDirty(ObjectAdapter object);
034
035    /**
036     * Checks if the specified object has been changed, and hence needs
037     * persisting.
038     * 
039     * @see #markDirty(ObjectAdapter)
040     * @see #clearDirty(ObjectAdapter)
041     */
042    boolean isDirty(ObjectAdapter object);
043
044    /**
045     * Mark the specified object as having been changed, and hence needing
046     * persisting.
047     * 
048     * @see #isDirty(ObjectAdapter)
049     * @see #clearDirty(ObjectAdapter)
050     */
051    void markDirty(ObjectAdapter object);
052
053}