View Javadoc

1   /*
2    * Copyright 2000-2001,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  package org.apache.jetspeed.om.registry;
18  
19  /***
20   * Interface for storing tool information for a portlet, control or controller
21   *
22   * @author <a href="mailto:raphael@apache.org">RaphaŽl Luta</a>
23   * @version $Id: ToolDescriptor.java,v 1.2 2004/02/23 03:11:39 jford Exp $
24   */
25  public interface ToolDescriptor
26  {
27      /*** @return the name of the tool */
28      public String getName();
29  
30      /*** Sets the name for this tool
31       * @param title the new name of the tool
32       */
33      public void setName( String name );
34  
35      /*** @return the scope of this tool */
36      public String getScope();
37  
38      /*** Sets the scope of this tool.
39       * The currently recognized scope are "request", "session", "persistent", "global"
40       * @param scope the new scope of this tool
41       */
42      public void setScope( String scope );
43  
44      /*** @return the clasname of this tool */
45      public String getClassname();
46  
47      /*** Sets the classname of this tool
48       * @param classname the new classname of this tool
49       */
50      public void setClassname( String classname );
51  }