KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > roller > pojos > Template


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. The ASF licenses this file to You
4  * under the Apache License, Version 2.0 (the "License"); you may not
5  * 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. For additional information regarding
15  * copyright in this work, please see the NOTICE file in the top level
16  * directory of this distribution.
17  */
18
19 package org.apache.roller.pojos;
20
21 import java.util.Date JavaDoc;
22
23
24 /**
25  * The Template interface represents the abstract concept of a single unit
26  * of templated or non-rendered content. For Roller we mainly think of
27  * templates as Velocity templates which are meant to be fed into the
28  * Velocity rendering engine.
29  */
30 public interface Template {
31     
32     /**
33      * The unique identifier for this Template.
34      *
35      * @roller.wrapPojoMethod type="simple"
36      */
37     public String JavaDoc getId();
38     
39     /**
40      * A simple name for this Template.
41      *
42      * @roller.wrapPojoMethod type="simple"
43      */
44     public String JavaDoc getName();
45     
46     /**
47      * A description of the contents of this Template.
48      *
49      * @roller.wrapPojoMethod type="simple"
50      */
51     public String JavaDoc getDescription();
52     
53     /**
54      * The contents or body of the Template.
55      *
56      * @roller.wrapPojoMethod type="simple"
57      */
58     public String JavaDoc getContents();
59     
60     /**
61      * The url link value for this Template. If this template is not
62      * private this is the url that it can be accessed at.
63      *
64      * @roller.wrapPojoMethod type="simple"
65      */
66     public String JavaDoc getLink();
67     
68     /**
69      * The last time the template was modified.
70      *
71      * @roller.wrapPojoMethod type="simple"
72      */
73     public Date JavaDoc getLastModified();
74     
75     /**
76      * Is the Template hidden? A hidden template cannot be accessed directly.
77      *
78      * @roller.wrapPojoMethod type="simple"
79      */
80     
81     public boolean isHidden();
82     
83     /**
84      * Is the Template to be included in the navbar?
85      *
86      * @roller.wrapPojoMethod type="simple"
87      */
88     public boolean isNavbar();
89     
90     /**
91      * The templating language used by this template.
92      */
93     public String JavaDoc getTemplateLanguage();
94     
95     /**
96      * The decorator Template to apply. This returns null if no decorator
97      * should be applied.
98      */
99     public Template getDecorator();
100     
101 }
102
Popular Tags