source/mir/storage/store/StorableObject.java

   1 /*
   2  * Copyright (C) 2001-2006 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * and distribute linked combinations including the two.  You must obey the
  23  * GNU General Public License in all respects for all of the code used other than
  24  * the above mentioned libraries.  If you modify this file, you may extend this
  25  * exception to your version of the file, but you are not obligated to do so.
  26  * If you do not wish to do so, delete this exception statement from your version.
  27  */
  28 package mir.storage.store;
  29
  30 /**
  31  * Title:         Interface StorableObject
  32  * Description:   Interface all Objects need to implement to be storable in the
  33  *                ObjectStore.
  34  * Copyright:     Copyright (c) 2002
  35  * Company:       indy
  36  * @author        rk
  37  * @version 1.0
  38  */
  39
  40 import java.util.Set;
  41
  42 public interface StorableObject {
  43
  44   /**
  45    *  Method getStoreIdentifier() forces StorableObjects to return a StoreIdentifier.
  46    *  if an Object implements this, it can be stored in ObjectStore. The ObjectStore.
  47    *  @see StoreIdentifier for a description of values needed for implementing
  48    *  getStoreIdentifier()
  49    *
  50    *  @return StoreIdentifier
  51    *
  52    */
  53   abstract  StoreIdentifier getStoreIdentifier();
  54
  55   /**
  56    *  Method:       notifyOnReleaseSet()
  57    *  Description:  Contains a Set of @see StoreIdentifier which are invalidated
  58    *                on update/insert/delete of this StorableObject.
  59    *
  60    *  @return       Set of StoreIdentifier.
  61    */
  62   abstract  Set getNotifyOnReleaseSet();
  63
  64 }