merged 1.1 branch into head

[mir.git] / source / mircoders / localizer / MirLocalizer.java

diff --git a/source/mircoders/localizer/MirLocalizer.java b/source/mircoders/localizer/MirLocalizer.java
index 6d6bda0..ec2c3c6 100755 (executable)
--- a/source/mircoders/localizer/MirLocalizer.java
+++ b/source/mircoders/localizer/MirLocalizer.java
@@ -30,12 +30,31 @@
 
 package mircoders.localizer;
 
+/**
+ * <p>Localizers  provide   a  customization  framework   that  allows
+ * different mir sites to behave differently. This is effectively used
+ * by various  indymedia sites to  customize things such  open posting
+ * mechanisms, open posting  validation, data model enhancements, etc.
+ * </p>
+ * 
+ * <p>The   <code>MirLocalizer</code>  interface  defines  the centralized
+ * localizer,     that     may  be accessed     via     the     global
+ * <function>MirGlobal.localizer()</function>  function.  The  central
+ * localizer  provides accessors to  domain specific  localizers (like
+ * <code>MirBasicOpenPostingLocalizer</code>).  </p>
+ *
+ * <p>      Default     behavior      is      provided     by      the
+ * <code>MirBasicLocalizer</code>  and it's associated  classes. These
+ * classes can be extended to override default behavior.</p>
+ *
+ */
+
 public interface MirLocalizer {
-  public MirProducerLocalizer producers() throws MirLocalizerFailure, MirLocalizerExc;
-  public MirAdminInterfaceLocalizer adminInterface() throws MirLocalizerFailure, MirLocalizerExc;
-  public MirOpenPostingLocalizer openPostings() throws MirLocalizerFailure, MirLocalizerExc;
-  public MirProducerAssistantLocalizer producerAssistant() throws MirLocalizerFailure, MirLocalizerExc;
-  public MirGeneratorLocalizer generators() throws MirLocalizerFailure, MirLocalizerExc;
-  public MirDataModelLocalizer dataModel() throws MirLocalizerFailure, MirLocalizerExc;
-  public MirMediaLocalizer media() throws MirLocalizerFailure, MirLocalizerExc;
+  public MirProducerLocalizer producers() throws MirLocalizerFailure;
+  public MirAdminInterfaceLocalizer adminInterface() throws MirLocalizerFailure;
+  public MirOpenPostingLocalizer openPostings() throws MirLocalizerFailure;
+  public MirProducerAssistantLocalizer producerAssistant() throws MirLocalizerFailure;
+  public MirGeneratorLocalizer generators() throws MirLocalizerFailure;
+  public MirDataModelLocalizer dataModel() throws MirLocalizerFailure;
+  public MirMediaLocalizer media() throws MirLocalizerFailure;
 }
\ No newline at end of file