/* 
    P/P   *  Method: org.apache.roller.weblogger.ui.core.plugins.WeblogEntryEditor__static_init
          */
     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.ui.core.plugins;
    20  
    21  /**
    22   * Represents an editor for a WeblogEntry.
    23   */
    24  public interface WeblogEntryEditor {
    25      
    26      /**
    27       * The unique identifier for this editor.
    28       *
    29       * It is important that each editor have a unique identifier.  The id for 
    30       * the editor is how it will be tracked and associated with each weblog 
    31       * that is using it, so having 2 editors with the same id would cause some
    32       * nasty problems.  It is also preferable if the id not be a full class
    33       * name because then if you ever want to refactor the location of the class
    34       * then you have a problem, so just pick a simple unique name.
    35       *
    36       * @return The unique identifier for this WeblogEntryEditor.
    37       */
    38      public String getId();
    39      
    40      
    41      /**
    42       * The display name for the editor, as seen by users.
    43       *
    44       * This is the name that users will see on the editors option list, so
    45       * pick something that's easy for users to remember and recognize.
    46       *
    47       * It is also a good idea for the name to be internationalized if possible.
    48       *
    49       * @return The display name of this WeblogEntryEditor.
    50       */
    51      public String getName();
    52      
    53      
    54      /**
    55       * The location of the jsp page inside the webapp that renders this editor.
    56       *
    57       * Example: /roller-ui/authoring/editors/editor-text.jsp
    58       *
    59       * @return The location of the jsp for this editor.
    60       */
    61      public String getJspPage();
    62  
    63  }