1 package org.apache.fulcrum.intake;
2
3 /*
4 * Licensed to the Apache Software Foundation (ASF) under one
5 * or more contributor license agreements. See the NOTICE file
6 * distributed with this work for additional information
7 * regarding copyright ownership. The ASF licenses this file
8 * to you under the Apache License, Version 2.0 (the
9 * "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$
27 */
28 public interface Retrievable
29 {
30 /**
31 * get an id that differentiates this object from others
32 * of its class.
33 *
34 * @return the unique key identifying the object
35 */
36 String getQueryKey();
37
38 /**
39 * set an id that differentiates this object from others
40 * of its class.
41 *
42 * @param key the identifying key
43 *
44 * @throws Exception if the key could not be set
45 */
46 void setQueryKey(String key) throws Exception;
47 }