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 the com.oreilly.servlet library, any library
  22  * licensed under the Apache Software License, The Sun (tm) Java Advanced
  23  * Imaging library (JAI), The Sun JIMI library (or with modified versions of
  24  * the above that use the same license as the above), and distribute linked
  25  * combinations including the two.  You must obey the GNU General Public
  26  * License in all respects for all of the code used other than the above
  27  * mentioned libraries.  If you modify this file, you may extend this exception
  28  * to your version of the file, but you are not obligated to do so.  If you do
  29  * not wish to do so, delete this exception statement from your version.
  30  */
  31
  32 package mircoders.localizer;
  33
  34 import java.util.List;
  35 import java.util.Map;
  36
  37 import mir.entity.adapter.EntityAdapter;
  38
  39 /**
  40  *
  41  * <p>Title: Interface to allow for localized changed to the workings of the admin system</p>
  42  * @author Zapata
  43  * @version 1.0
  44  */
  45
  46 public interface MirAdminInterfaceLocalizer {
  47   /**
  48    * Every time an article gets made inside the admin system, this function is called. It is
  49    * possible to set different initial values for the article here.
  50    *
  51    * @param anArticle The map that can be changed. For example, to set a default author, do
  52    *   <p>
  53    *     <code>anArticle.put("creator", "editorial team");</code>
  54    */
  55   public void initializeArticle(Map anArticle);
  56
  57   /**
  58    * Allows passwords to be stored encrypted in the database. Just implement this
  59    * function and return a digest of the supplied password. This function should always
  60    * return the same digest for the same password.
  61    *
  62    * @param aPassword The password to be digested
  63    * @return The digested password
  64    */
  65   public String makePasswordDigest(String aPassword);
  66
  67
  68   /**
  69    *
  70    * @return
  71    */
  72   public List simpleCommentOperations();
  73
  74   /**
  75    *
  76    * @param aName
  77    * @return
  78    */
  79   public MirSimpleEntityOperation simpleCommentOperationForName(String aName);
  80
  81
  82   public List simpleArticleOperations();
  83   public MirSimpleEntityOperation simpleArticleOperationForName(String aName);
  84
  85   public interface MirSimpleEntityOperation {
  86     public String getName();
  87     public boolean isAvailable(EntityAdapter anEntity);
  88     public void perform(EntityAdapter aUser, EntityAdapter anEntity);
  89   }
  90 }