StorageHomeBase


1   /*====================================================================
2   
3   OpenCCM: The Open CORBA Component Model Platform
4   Copyright (C) 2000-2004 INRIA & USTL - LIFL - GOAL
5   Contact: openccm@objectweb.org
6   
7   This library is free software; you can redistribute it and/or
8   modify it under the terms of the GNU Lesser General Public
9   License as published by the Free Software Foundation; either
10  version 2.1 of the License, or any later version.
11  
12  This library is distributed in the hope that it will be useful,
13  but WITHOUT ANY WARRANTY; without even the implied warranty of
14  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  Lesser General Public License for more details.
16  
17  You should have received a copy of the GNU Lesser General Public
18  License along with this library; if not, write to the Free Software
19  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307
20  USA
21  
22  Initial developer(s): Christophe Demarey.
23  Contributor(s): ______________________________________.
24  
25  ====================================================================*/
26  
27  package org.objectweb.openccm.pss.runtime.jdo.api;
28  
29  
30  /**
31   * This interface describe a JDO Session.
32   *
33   * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
34   *
35   * @version 0.1
36   */
37  
38  public interface StorageHomeBase
39           extends org.objectweb.openccm.pss.runtime.common.api.StorageHomeBase
40  {
41      /**
42       * Must be called before create method invokation.
43       */
44      public void
45      before_create();
46  
47      /**
48       * Must be called after create method invokation.
49       *
50       * @param st - The storage type to make persistent.
51       */
52      public void
53      after_create(org.objectweb.openccm.pss.runtime.jdo.api.StorageObject st);
54  
55      /**
56       * Create a pid for a storage type.
57       *
58       * @param short_pid - The short_pid of the storage type to encode.
59       *
60       * @return The storage type PID.
61       */
62      public byte[]
63      create_pid(String   short_pid);
64  
65      /**
66       * Must be called after create method invokation.
67       *
68       * @param fields_names - Name of fields contained in the key.
69       * @param fields_types - Type of fields contained in the key.
70       * @param key_values - Value of fields contained in the key.
71       *
72       * @return The storage object matching to key values, else null.
73       *
74       * @throws org.omg.CosPersistentState.NotFound if there is no matching storage object.
75       */
76      public Object  
77      find_by_key(String  [] fields_names,
78                  String  [] fields_types,
79                  java.lang.Object  [] key_values)
80      throws org.omg.CosPersistentState.NotFound;
81  }
82
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags