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