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.profiler;
18  
19  /***
20   * ProfileLocatorElement
21   *
22   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
23   * @version $Id: ProfileLocatorProperty.java 516448 2007-03-09 16:25:47Z ate $
24   */
25  public interface ProfileLocatorProperty
26  {    
27      /***
28       * Gets the value of the locator property.
29       * 
30       * @return The value of the property.
31       */
32      String getValue();
33      
34      /***
35       * Sets the value of the locator property.
36       * @param value The value of the property.
37       */
38      void setValue(String value);
39  
40  
41      /***
42       * Returns the fallback type of the property.
43       * see 
44       * 
45       * @return
46       */
47      int getFallbackType();
48  
49      /***
50       * @return
51       */
52      String getName();
53  
54      /***
55       * @return
56       */
57      String getType();
58  
59      /***
60       * @param i
61       */
62      void setFallbackType(int type);
63  
64      /***
65       * @param string
66       */
67      void setName(String string);
68      
69      /***
70       * @param string
71       */
72      void setType(String type);    
73  
74      /***
75       * @return control classification flag
76       */
77      boolean isControl();
78      
79      /***
80       * @return true if a property is a navigation
81       */
82      boolean isNavigation();
83  }