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.locator;
18  
19  /***
20   * TemplateDescriptor
21   *
22   * @author <a href="mailto:taylor@apache.org">David Sean Taylor</a>
23   * @version $Id: TemplateDescriptor.java 516448 2007-03-09 16:25:47Z ate $
24   */
25  public interface TemplateDescriptor extends LocatorDescriptor
26  {
27      /***
28       * The absolute file system path to the template
29       *  
30       * @return absolute path
31       */    
32      String getAbsolutePath();
33      
34      /***
35       * The absolute file system path to the template
36       *  
37       * @param absolute path
38       */    
39      void setAbsolutePath(String path);
40      
41  	/***
42  	 * Returns the template path relative to the applications root
43  	 * @return Application-relative path
44  	 */
45  	public String getAppRelativePath();
46  	/***
47  	 * Sets the template path relative to the applications root
48  	 * @param string Application-relative path
49  	 */
50  	public void setAppRelativePath(String string);
51  }