cleanup / abuse system fix / prepping for a release

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

diff --git a/source/mircoders/localizer/MirAdminInterfaceLocalizer.java b/source/mircoders/localizer/MirAdminInterfaceLocalizer.java
index 3577723..3c5880d 100755 (executable)
--- a/source/mircoders/localizer/MirAdminInterfaceLocalizer.java
+++ b/source/mircoders/localizer/MirAdminInterfaceLocalizer.java
@@ -101,8 +101,19 @@ public interface MirAdminInterfaceLocalizer {
   public List simpleArticleOperations();
 
   public interface MirSimpleEntityOperation {
+    /**
+     * Returns the name of the operation. Must be unique and immutable.
+     */
     public String getName();
+
+    /**
+     * Is the operation valid for the given {@link EntityAdapter}
+     */
     public boolean isAvailable(EntityAdapter anEntity) throws MirLocalizerExc, MirLocalizerFailure;
+
+    /**
+     * perform the operation on the given {@link EntityAdapter} as the given user
+     */ 
     public void perform(EntityAdapter aUser, EntityAdapter anEntity) throws MirLocalizerExc, MirLocalizerFailure;
   }
 }
\ No newline at end of file