View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *      http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.om.page;
18  
19  import org.apache.jetspeed.om.common.SecuredResource;
20  
21  /***
22   * BaseElement
23   *
24   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
25   * @version $Id: BaseElement.java 516448 2007-03-09 16:25:47Z ate $
26   */
27  public interface BaseElement extends SecuredResource
28  {
29      /***
30       * Returns the unique Id of this element. This id is guaranteed to be unique
31       * from the complete portal and is suitable to be used as a unique key.
32       *
33       * @return the unique id of this element.
34       */
35      public String getId();
36  
37      /***
38       * Returns the title in the default Locale
39       *
40       * @return the page title
41       */
42      public String getTitle();
43  
44      /***
45       * Sets the title for the default Locale
46       *
47       * @param title the new title
48       */
49      public void setTitle(String title);
50  
51      /***
52       * Returns the short title in the default Locale
53       *
54       * @return the page short title
55       */
56      public String getShortTitle();
57  
58      /***
59       * Sets the short title for the default Locale
60       *
61       * @param title the new title
62       */
63      public void setShortTitle(String title);
64          
65  }