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.common;
18  
19  import java.util.Locale;
20  
21  import org.apache.pluto.om.common.Description;
22  
23  /***
24   * MutableDescription
25   * <br/>
26   * Extended version of <code>org.apache.pluto.om.common.Description</code>
27   * that allows for setting the description text and Locale for the description
28   * object.
29   * 
30   * @author <a href="mailto:weaver@apache.org">Scott T. Weaver</a>
31   * @version $Id: MutableDescription.java 516448 2007-03-09 16:25:47Z ate $
32   *
33   */
34  public interface MutableDescription extends Description
35  {
36  
37      String TYPE_PORTLET_APP = "org.apache.pluto.om.common.Description.portletApplication";
38      String TYPE_WEB_APP = "org.apache.pluto.om.common.Description.webApplication";
39      String TYPE_PORTLET = "org.apache.pluto.om.common.Description.portlet";
40      String TYPE_PORTLET_ENTITY = "org.apache.pluto.om.common.Description.portletEntity";
41      String TYPE_PARAMETER = "org.apache.pluto.om.common.Description.parameter";
42      String TYPE_PREFERENCE = "org.apache.pluto.om.common.Description.preference";
43      String TYPE_SEC_ROLE_REF = "org.apache.pluto.om.common.Description.securityRoleRef";
44  
45      void setDescription(String description);
46  
47      void setLocale(Locale locale);
48  
49  }