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.weblogger.pojos;
    20  
    21  
    22  /**
    23   * A Theme specific implementation of a Template.
    24   * 
    25   * A ThemeTemplate represents a template which is part of a Theme.
    26   */
    27  public interface ThemeTemplate extends Template {
    28      
    29      public static final String ACTION_WEBLOG = "weblog";
    30      public static final String ACTION_PERMALINK = "permalink";
    31      public static final String ACTION_SEARCH = "search";
    32      public static final String ACTION_TAGSINDEX = "tagsIndex";
    33      public static final String ACTION_CUSTOM = "custom";
    34      
    35      // the full list of supported special actions, which purposely does not
    36      // contain an entry for the 'custom' action
             /* 
    P/P       *  Method: org.apache.roller.weblogger.pojos.ThemeTemplate__static_init
              * 
              *  Postconditions:
              *    ACTIONS == &new String[](ThemeTemplate__static_init#1)
              *    new String[](ThemeTemplate__static_init#1) num objects == 1
              *    ACTIONS.length == 4
              *    ACTIONS[0] == &"weblog"
              *    ACTIONS[1] == &"permalink"
              *    ACTIONS[2] == &"search"
              *    ACTIONS[3] == &"tagsIndex"
              */
    37      public static final String[] ACTIONS = {
    38          ACTION_WEBLOG, 
    39          ACTION_PERMALINK, 
    40          ACTION_SEARCH, 
    41          ACTION_TAGSINDEX
    42      };
    43      
    44      
    45      /**
    46       * The action this template is defined for.
    47       */
    48      public String getAction();
    49      
    50      
    51      /**
    52       * The contents or body of the Template.
    53       */
    54      public String getContents();
    55      
    56      
    57      /**
    58       * The url link value for this Template.  If this template is not
    59       * private this is the url that it can be accessed at.
    60       */
    61      public String getLink();
    62      
    63      
    64      /**
    65       * Is the Template hidden?  A hidden template cannot be accessed directly.
    66       */
    67      public boolean isHidden();
    68      
    69      
    70      /**
    71       * Is the Template to be included in the navbar?
    72       */
    73      public boolean isNavbar();
    74      
    75      
    76      /**
    77       * The name of the decorator template to apply.
    78       */
    79      public String getDecoratorName();
    80      
    81      
    82      /**
    83       * The decorator Template to apply.  This returns null if no decorator
    84       * should be applied.
    85       */
    86      public ThemeTemplate getDecorator();
    87      
    88  }