##### Coverage Report - org.apache.turbine.om.Retrievable

Classes in this File | Line Coverage | Branch Coverage | Complexity
Retrievable |
N/A | N/A
N/A | N/A
| 1.0;1

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: Retrievable.java 1706425 2015-10-02 14:47:51Z tv $
29 |  |
      */
30 |  |
     public interface Retrievable
31 |  |
     {
32 |  |
         /**
33 |  |
          * get an id that differentiates this object from others
34 |  |
          * of its class.
35 |  |
          *
36 |  |
          * @return The id value
37 |  |
          */
38 |  |
         String getQueryKey();
39 |  |
40 |  |
         /**
41 |  |
          * set an id that differentiates this object from others
42 |  |
          * of its class.
43 |  |
          *
44 |  |
          * @param key The new id value
45 |  |
          *
46 |  |
          * @throws Exception A problem occurred while setting the id.
47 |  |
          */
48 |  |
         void setQueryKey(String key)
49 |  |
             throws Exception;
50 |  |
51 |  |
     }