From 663a7450b1c57122618c57d48c5c797d6767ce70 Mon Sep 17 00:00:00 2001
From: Radovan Semancik <radovan.semancik@evolveum.com>
Date: Thu, 16 Mar 2017 11:32:04 +0100
Subject: [PATCH] Better ModelExecuteOptions documentation

---
 .../xml/ns/public/common/common-core-3.xsd       | 11 ++++++++---
 .../midpoint/model/api/ModelExecuteOptions.java  | 16 +++++++++++++++-
 2 files changed, 23 insertions(+), 4 deletions(-)

diff --git a/infra/schema/src/main/resources/xml/ns/public/common/common-core-3.xsd b/infra/schema/src/main/resources/xml/ns/public/common/common-core-3.xsd
index 30ffdd89e99..fc5aa61fb6b 100644
--- a/infra/schema/src/main/resources/xml/ns/public/common/common-core-3.xsd
+++ b/infra/schema/src/main/resources/xml/ns/public/common/common-core-3.xsd
@@ -12449,7 +12449,8 @@
     <xsd:complexType name="ModelExecuteOptionsType">
         <xsd:annotation>
             <xsd:documentation>
-                TODO
+                Options for execution of Model operations. These options influence the way how the operations are executed.
+                The options are not mandatory. All options have reasonable default values. They may not be specified at all.
             </xsd:documentation>
         </xsd:annotation>
         <xsd:sequence>
@@ -12475,13 +12476,16 @@
                     <xsd:documentation>
                         Avoid encryption of any cleartext data on write. Applies only to the encrypted
                         data formats (ProtectedString, ProtectedByteArray).
+                        It is not recommended to use in production environment. This option is provided only for diagnostic
+						purposes to be used in development environments.
                     </xsd:documentation>
                 </xsd:annotation>
             </xsd:element>
             <xsd:element name="reconcile" type="xsd:boolean" minOccurs="0">
                 <xsd:annotation>
                     <xsd:documentation>
-                        Option to reconcile user while executing changes.
+                        Option to reconcile focus and all projections while executing changes.
+						(implies reconcileFocus)
                     </xsd:documentation>
                 </xsd:annotation>
             </xsd:element>
@@ -12557,7 +12561,8 @@
             <xsd:element name="partialProcessing" type="tns:PartialProcessingOptionsType" minOccurs="0">
                 <xsd:annotation>
                     <xsd:documentation>
-                        Business context that describes this request.
+                        Options that control selective execution of model logic.
+                        Use with extreme care. Some combinations may be dangerous.
                     </xsd:documentation>
                 </xsd:annotation>
             </xsd:element>
diff --git a/model/model-api/src/main/java/com/evolveum/midpoint/model/api/ModelExecuteOptions.java b/model/model-api/src/main/java/com/evolveum/midpoint/model/api/ModelExecuteOptions.java
index ffdf9a4f7cc..0937b9bb88b 100644
--- a/model/model-api/src/main/java/com/evolveum/midpoint/model/api/ModelExecuteOptions.java
+++ b/model/model-api/src/main/java/com/evolveum/midpoint/model/api/ModelExecuteOptions.java
@@ -25,8 +25,10 @@
 import java.util.List;
 
 /**
+ * Options for execution of Model operations. These options influence the way how the operations are executed.
+ * The options are not mandatory. All options have reasonable default values. They may not be specified at all.
+ * 
  * @author semancik
- *
  */
 public class ModelExecuteOptions extends AbstractOptions implements Serializable, Cloneable {
 	
@@ -46,6 +48,8 @@ public class ModelExecuteOptions extends AbstractOptions implements Serializable
 	/**
 	 * Encrypt any cleartext data on write, decrypt any encrypted data on read. Applies only to the encrypted
 	 * data formats (ProtectedString, ProtectedByteArray).
+	 * It is not recommended to use in production environment. This option is provided only for diagnostic
+	 * purposes to be used in development environments.
 	 */
 	private Boolean noCrypt;
 	
@@ -88,6 +92,9 @@ public class ModelExecuteOptions extends AbstractOptions implements Serializable
      */
 	private Boolean overwrite;
     
+	/**
+	 * Option to simulate import operation. E.g. search filters will be resolved.
+	 */
 	private Boolean isImport;
 
 	/**
@@ -106,8 +113,15 @@ public class ModelExecuteOptions extends AbstractOptions implements Serializable
 	 */
 	private Boolean preAuthorized;
 	
+	/**
+	 * Business context that describes this request.
+	 */
 	private OperationBusinessContextType requestBusinessContext;
 	
+	/**
+	 * Options that control selective execution of model logic.
+     * Use with extreme care. Some combinations may be dangerous.
+	 */
 	private PartialProcessingOptionsType partialProcessing;
 
     public Boolean getForce() {