View Javadoc

1   /* ===================================================================
2    * Copyright 2002-04 SRI International.
3    * Released under the MOZILLA PUBLIC LICENSE Version 1.1
4    * which can be obtained at http://www.mozilla.org/MPL/MPL-1.1.html
5    * This software is distributed on an "AS IS"
6    * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied.
7    * See the License for the specific language governing rights and
8    * limitations under the License.
9    * =================================================================== */
10  package com.sri.emo.dbobj;
11  
12  import com.jcorporate.expresso.core.controller.Transition;
13  import com.jcorporate.expresso.core.db.DBException;
14  
15  /***
16   * provide a transition for viewing, suitable for creating an
17   * HTTP link when all you have is a reference to this object.  therefore, one requirement
18   * is that all information for such a transition
19   * (typically a controller/state combo, plus ID, plus name for label) must be
20   * contained in the object.
21   *
22   * @author Larry Hamel
23   */
24  public interface IViewable {
25  
26      /***
27       * Provide a transition for viewing this object, suitable for creating an
28       * HTTP link.
29       *
30       * @return transtion for viewing, including label for name of object; never null
31       * @throws DBException upon database access error.
32       */
33      Transition getViewTrans() throws DBException;
34  }