/*  PAT: Persistent Applications Toolkit (patsystem.sf.net)
 *  Copyright (C) 2004, 2005  Tomasz Nazar, nthx at irc dot pl
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Full version of the license is /docs/LICENSE.txt
 */
package org.nthx.pat;


import java.util.Map;

/** Every business object (specified by '@@ pat.bo' tag) exists in this map.
 *
 *  @version $Id: IdentityMap.java 3725 2005-06-09 23:57:03Z nthx $
 *  @author nthx@users.sourceforge.net
 */
public interface IdentityMap
{
    //--- Implementation --------
    Identifiable putObject(Identifiable identifiable);

    Identifiable getObject(Long oid);

    Long generateUniqueOID();

    Identifiable removeObject(Identifiable bo);

    /** For root-creation-and-tmp-IM managing.. */
    void setMap(Map map);
    Map getMapForTestsOnly();

    /** For root-creation-and-tmp-IM managing.. */
    void setUniqueOID(long uniqueOID);

    long getUniqueOID();

    int getSize();
}