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