Changes between Version 2 and Version 3 of maestro/MaestroAPI/2.1ApiChanges

Timestamp:

Apr 12, 2010, 6:47:43 AM (14 years ago)

Author:

jng

Comment:

--

maestro/MaestroAPI/2.1ApiChanges

@@ -43 +43 @@
 
 An array (string[]) of possible input values for the given property.
+
+=== ExecuteLoadProcedure ===
+
+Implemented in ServerConnectionBase, automatically inherited by HttpServerConnection and LocalNativeConnetion
+
+Description: Executes the Load Procedure specified by the resource ID.
+
+Parameters:
+
+ * resourceID: The resource ID of the Load Procedure
+ * ignoreUnsupportedFeatures: If false, will throw an exception if the specified load procedure has features which are not supported for execution.
+ * callback: An optional callback to indicate progress.
+
+Returns:
+
+ * An array of resource IDs that have been created or updated by the execution of this load procedure.
+
+Notes:
+
+The Load Procedure support in Maestro is very basic. The following load procedure types are supported:
+
+ * SDF
+ * SHP
+
+The following Load Procedure types '''may be supported''' in future releases, if it is determined we can support these types with a portable implementation:
+
+ * DWF
+ * SQLite
+ * Raster
+
+The following Load Procedure types will '''NEVER''' be supported:
+ 
+ * DWG
+
+Of the supported load procedure types, the following features are not supported, and will throw an exception if ignoreUnsupportedFeatures = false
+
+ * Generalization of data (will throw exception if value < 100%)
+ * Convert to SDF (will throw exception if value = true)
+
+Of the supported load procedure types, the following features are not supported. No exception is thrown regardless of the value of ignoreUnsupportedFeatures
+
+ * SDF2 to SDF3 conversion (there's no pure .net way to detect if the input files are SDF2 files)
+ * SDF duplicate record (there's no portable .net API available to inspect the contents of a local SDF file)
+
+The general use case for Load Procedures is the quick and dirty loading of a group of SDF/SHP files into a given repository location, each referenced by a matching layer with default (monochromatic) styles. As long as you stick to this general usage scenario, the API will work as expected. These unsupported features are disabled on the user interface side.