KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > jonas_ejb > container > jorm > Coder


1 /*
2  * JOnAS: Java(TM) Open Application Server
3  * Copyright (C) 1999 Bull S.A.
4  * Contact: jonas-team@objectweb.org
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or any later version.
10  *
11  * This library 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 GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19  * USA
20  *
21  * Initial developer(s): Sebastien Chassande
22  * Contributor(s):
23  *
24  * --------------------------------------------------------------------------
25  * $Id: Coder.java,v 1.3 2003/03/14 13:28:07 durieuxp Exp $
26  * --------------------------------------------------------------------------
27  */
28
29 package org.objectweb.jonas_ejb.container.jorm;
30
31 import org.objectweb.jorm.api.PException;
32 import org.objectweb.jorm.naming.api.PName;
33
34 /**
35  * This interface specifies two methods to translate a PName into a PK or the
36  * opposite action.
37  *
38  * @author Sebastien Chassande-Barrioz
39  */
40 public interface Coder {
41
42     /**
43      * This method build a PName with the primary key specifed in parameter.
44      * @param pk the primary key
45      * @return the PName
46      * @throws PException the operation has failed
47      * @throws UnsupportedOperationException operation not supported.
48      */
49     PName decode(Object JavaDoc pk) throws PException, UnsupportedOperationException JavaDoc;
50
51     /**
52      * This method build a primary key with the PName specifed in parameter.
53      * @param pn the Jorm PName
54      * @return the primary key
55      * @throws PException the operation has failed
56      * @throws UnsupportedOperationException operation not supported.
57      */
58     Object JavaDoc encode(PName pn) throws PException, UnsupportedOperationException JavaDoc;
59 }
60
Popular Tags