BIS-222 - Make STORAGE_CONFIRMED available in dataset search for admins:

- improve javadoc
- make ISearchFieldAvailability and ISearchFieldCriterionFactory interfaces more consistent

SVN: 26991

openbis/source/java/ch/systemsx/cisd/openbis/generic/client/web/client/application/ui/search/DetailedSearchFieldsSelectionWidget.java

@@ -235,7 +235,7 @@ public final class DetailedSearchFieldsSelectionWidget extends
                     field.getKind() != null ? field.getKind().getAvailability() : null;
 
             if (availability != null
-                    && availability.isAvailable(getPerson(), getPersonRoles()) == false)
+                    && availability.isAvailable(field.getField(), getPerson(), getPersonRoles()) == false)
             {
                 iterator.remove();
             }

openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/ISearchFieldAvailability.java

@@ -17,11 +17,16 @@
 package ch.systemsx.cisd.openbis.generic.shared.basic.dto;
 
 /**
+ * Controls availability of a search field.
+ * 
  * @author pkupczyk
  */
 public interface ISearchFieldAvailability
 {
 
-    public boolean isAvailable(Person person, PersonRoles personRoles);
+    /**
+     * Returns true if the search field should be available for the specified person and roles.
+     */
+    public boolean isAvailable(DetailedSearchField field, Person person, PersonRoles personRoles);
 
 }

openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/ISearchFieldCriterionFactory.java

@@ -16,13 +16,17 @@
 
 package ch.systemsx.cisd.openbis.generic.shared.basic.dto;
 
-
 /**
+ * Creates a criterion for a search field.
+ * 
  * @author pkupczyk
  */
 public interface ISearchFieldCriterionFactory
 {
 
+    /**
+     * Creates a criterion for the search field and value.
+     */
     public DetailedSearchCriterion createCriterion(DetailedSearchField field, String value);
 
 }

openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/ISearchFieldKind.java

@@ -16,15 +16,22 @@
 
 package ch.systemsx.cisd.openbis.generic.shared.basic.dto;
 
-
 /**
+ * Kind of field that can be used in detailed text queries.
+ * 
  * @author pkupczyk
  */
 public interface ISearchFieldKind
 {
 
+    /**
+     * Returns availability of the search field.
+     */
     ISearchFieldAvailability getAvailability();
 
+    /**
+     * Returns criterion factory of the search field.
+     */
     ISearchFieldCriterionFactory getCriterionFactory();
 
 }

openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/SearchFieldAvailableForAdmins.java

@@ -17,13 +17,15 @@
 package ch.systemsx.cisd.openbis.generic.shared.basic.dto;
 
 /**
+ * Makes a search field available for an admin used.
+ * 
  * @author pkupczyk
  */
 public class SearchFieldAvailableForAdmins implements ISearchFieldAvailability
 {
 
     @Override
-    public boolean isAvailable(Person person, PersonRoles personRoles)
+    public boolean isAvailable(DetailedSearchField field, Person person, PersonRoles personRoles)
     {
         return personRoles.isAdmin();
     }

openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/SearchFieldBooleanCriterionFactory.java

@@ -16,8 +16,10 @@
 
 package ch.systemsx.cisd.openbis.generic.shared.basic.dto;
 
-
 /**
+ * Creates a criterion for a boolean field. Accepts following values: "true", "yes", "false", "no".
+ * For other values is returns null.
+ * 
  * @author pkupczyk
  */
 public class SearchFieldBooleanCriterionFactory implements ISearchFieldCriterionFactory

openbis/source/java/ch/systemsx/cisd/openbis/generic/shared/basic/dto/SearchFieldDateCriterionFactory.java

@@ -16,8 +16,10 @@
 
 package ch.systemsx.cisd.openbis.generic.shared.basic.dto;
 
-
 /**
+ * Creates a criterion for a date field. Supports registration and modification dates with equals,
+ * from and until versions.
+ * 
  * @author pkupczyk
  */
 public class SearchFieldDateCriterionFactory implements ISearchFieldCriterionFactory