plugins/org.eclipse.osee.framework.ui.skynet/src/org/eclipse/osee/framework/ui/skynet/widgets/ArtifactStoredWidget.java

/*********************************************************************
 * Copyright (c) 2004, 2007 Boeing
 *
 * This program and the accompanying materials are made
 * available under the terms of the Eclipse Public License 2.0
 * which is available at https://www.eclipse.org/legal/epl-2.0/
 *
 * SPDX-License-Identifier: EPL-2.0
 *
 * Contributors:
 *     Boeing - initial API and implementation
 **********************************************************************/

package org.eclipse.osee.framework.ui.skynet.widgets;

import org.eclipse.osee.framework.core.util.Result;
import org.eclipse.osee.framework.skynet.core.artifact.Artifact;

/**
 * Used by XWidgets that perform data binding using OSEE artifacts
 *
 * @author Roberto E. Escobar
 */
public interface ArtifactStoredWidget {

   /**
    * @return the artifact
    */
   Artifact getArtifact();

   /**
    * Save data changes to artifact
    */
   void saveToArtifact();

   /**
    * Revert changes to widget data back to what was in artifact
    */
   void revert();

   /**
    * Return true if storage data different than widget data
    */
   Result isDirty();

   /**
    * Reload widget from current attribute value
    */
   default void reSet() {
      // if necessary reload the bound data
   }
}