source/mircoders/localizer/MirAdminInterfaceLocalizer.java

   1 /*
   2  * Copyright (C) 2001, 2002 The Mir-coders group
   3  *
   4  * This file is part of Mir.
   5  *
   6  * Mir is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * Mir is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with Mir; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  * In addition, as a special exception, The Mir-coders gives permission to link
  21  * the code of this program with  any library licensed under the Apache Software License,
  22  * The Sun (tm) Java Advanced Imaging library (JAI), The Sun JIMI library
  23  * (or with modified versions of the above that use the same license as the above),
  24  * and distribute linked combinations including the two.  You must obey the
  25  * GNU General Public License in all respects for all of the code used other than
  26  * the above mentioned libraries.  If you modify this file, you may extend this
  27  * exception to your version of the file, but you are not obligated to do so.
  28  * If you do not wish to do so, delete this exception statement from your version.
  29  */
  30 package mircoders.localizer;
  31
  32 import java.util.List;
  33 import java.util.Map;
  34
  35 import mir.entity.adapter.EntityAdapter;
  36 import mir.generator.Generator;
  37
  38 /**
  39  * Interface to allow for localized changed to the workings of the admin system
  40  *
  41  * @author Zapata
  42  */
  43
  44 public interface MirAdminInterfaceLocalizer {
  45   /**
  46    * Every time an article gets made inside the admin system, this function is called. It is
  47    * possible to set different initial values for the article here.
  48    *
  49    * @param anArticle The map that can be changed. For example, to set a default author, do
  50    *   <p>
  51    *     <code>anArticle.put("creator", "editorial team");</code>
  52    */
  53   public void initializeArticle(Map anArticle);
  54
  55   /**
  56    * Allows passwords to be stored encrypted in the database. Just implement this
  57    * function and return a digest of the supplied password. This function should always
  58    * return the same digest for the same password.
  59    *
  60    * @param aPassword The password to be digested
  61    * @return The digested password
  62    */
  63   public String makePasswordDigest(String aPassword);
  64
  65   /**
  66    * Allows different "generators" (templates) to be used for certain pages
  67    *
  68    * @param aPage The identifier of the page
  69    * @param aUser the user (can be used to allow different users to see different pages
  70    * @param aDefault The default generator
  71    * @return
  72    */
  73   public String getAdminPageGenerator(String aPage, Map aTemplateData, EntityAdapter aUser, String aDefault) throws MirLocalizerExc;
  74
  75   /**
  76    * Prepares an article preview
  77    *
  78    * @param aPreviewPage there may be different preview pages for a single article.
  79    *     (i.e. the same article may lead to different pages) this parameter selects one
  80    *      of those versions. See also {@link #getPreviewPages}.
  81    * @param anArticle the article to be previewed
  82    * @param aContext the context to be supplied to the generator
  83    * @return the generator to be used to generate the preview
  84    */
  85   public Generator prepareArticlePreview(String aPreviewPage, EntityAdapter anArticle, Map aContext)
  86       throws MirLocalizerExc, MirLocalizerFailure;
  87
  88   /**
  89    * Return the available preview variations of one article
  90    */
  91   public List getPreviewPages(EntityAdapter anArticle) throws MirLocalizerExc, MirLocalizerFailure;
  92
  93   /**
  94    * Get the {@link List} of {@link EntityOperation}s available for comments
  95    */
  96   public List simpleCommentOperations();
  97
  98   /**
  99    * Get the {@link List} of {@link EntityOperation}s available for articles
 100    */
 101   public List simpleArticleOperations();
 102
 103   public interface EntityOperation {
 104     /**
 105      * Returns the name of the operation. Must be unique and immutable.
 106      */
 107     public String getName();
 108
 109     /**
 110      * Is the operation valid for the given {@link EntityAdapter}
 111      */
 112     public boolean isAvailable(EntityAdapter anEntity) throws MirLocalizerExc, MirLocalizerFailure;
 113
 114     /**
 115      * perform the operation on the given {@link EntityAdapter} as the given user
 116      */
 117     public void perform(EntityAdapter aUser, EntityAdapter anEntity) throws MirLocalizerExc, MirLocalizerFailure;
 118   }
 119 }