1 package org.apache.turbine.om;
2
3 /*
4 * Copyright 2001-2005 The Apache Software Foundation.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License")
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 /***
20 * This interface specifies methods for uniquely identifying an object.
21 *
22 * @author <a href="mailto:jmcnally@collab.net">John D. McNally</a>
23 * @version $Id: Retrievable.java 264148 2005-08-29 14:21:04Z henning $
24 */
25 public interface Retrievable
26 {
27 /***
28 * get an id that differentiates this object from others
29 * of its class.
30 *
31 * @return The id value
32 */
33 String getQueryKey();
34
35 /***
36 * set an id that differentiates this object from others
37 * of its class.
38 *
39 * @param key The new id value
40 *
41 * @throws Exception A problem occured while setting the id.
42 */
43 void setQueryKey(String key)
44 throws Exception;
45
46 }