Differences

This shows you the differences between two versions of the page.

--- thinkgeo.mapsuite.core.transactionresult [2015/08/20 03:08]
127.0.0.1 external edit
+++ thinkgeo.mapsuite.core.transactionresult [2017/03/16 21:59] (current)
@@ Line 1: / Line 1: @@
 ====== ThinkGeo.MapSuite.Core.TransactionResult ======
+{{section>upgrade_map_suite_to_10.0}}
-<!-- Class -->
 This class represents the results of a transaction that was processed.
-=== Remarks ===
-This class holds the results of a transaction. It can tell the users the number of succeeded record and the number of failed records. It also has a dictionary that holds the individual reasons that certain records fails by FeatureId. If you are implementing this class it is important that you provide as much information about the transaction results to your users.
 ===== Inheritance Hierarchy =====
-*System.Object
+  *System.Object
-**[[ThinkGeo.MapSuite.Core.TransactionResult]]
+    ***ThinkGeo.MapSuite.Core.TransactionResult**
 ===== Members Summary =====
 ==== Public Constructors ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} TransactionResult() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#TransactionResult()|TransactionResult]]   |    |    | This is the class constructor.   |
-| {{wiki:PublicMethod.gif|Public Method}}[[#TransactionResult(Int32, Int32, Dictionary<String, String>, TransactionResultStatus)|TransactionResult]]   | Int32, Int32, Dictionary<String, String>, [[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]]   |    | This is the class constructor.   |
-==== Protected Constructors ====
+  * //This is the class constructor.//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //This is the default constructor and is typically not used.//
+== Parameters ==
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} TransactionResult(Int32,Int32,Dictionary<String,String>,TransactionResultStatus) **
+  * //N/A//
+== Remarks ==
+  * //N/A//
+== Parameters ==
+  * //totalSuccessCount//
+    * Type:Int32
+    * Description:N/A
+  * //totalFailureCount//
+    * Type:Int32
+    * Description:N/A
+  * //failureReasons//
+    * Type:Dictionary<String,String>
+    * Description:N/A
+  * //transactionResultStatus//
+    * Type:[[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]]
+    * Description:N/A
+<div newline></div>
+==== Protected Constructors ====
 ==== Public Methods ====
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+** {{wiki:PublicMethod.gif|}} ToString() **
-| {{wiki:PublicMethod.gif|Public Method}}[[#Equals(Object)|Equals]]   | Object   | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetHashCode()|GetHashCode]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#GetType()|GetType]]   |    | Object   |    |
-| {{wiki:PublicMethod.gif|Public Method}}[[#ToString()|ToString]]   |    | Object   |    |
-==== Protected Methods ====
+  * //N/A//
-^ Name ^ Parameters ^ DeclaringType ^ Summary ^
+== Remarks ==
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]]   |    | Object   |    |
+  * //N/A//
-| {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]]   |    | Object   |    |
-==== Public Properties ====
+== Return Value ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+  * Type:String
-| {{wiki:PublicProperty.gif|Public Property}}[[#FailureReasons|FailureReasons]]   | Dictionary<String,String>   |    | This property gets and sets the dictionary that contains the reasons for failure.   |
+  * Description:N/A
-| {{wiki:PublicProperty.gif|Public Property}}[[#TotalFailureCount|TotalFailureCount]]   | Int32   |    | This property gets and sets the total number of records that we committed unsuccessfully.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#TotalSuccessCount|TotalSuccessCount]]   | Int32   |    | This property gets and sets the total number of records that we committed successfully.   |
-| {{wiki:PublicProperty.gif|Public Property}}[[#TransactionResultStatus|TransactionResultStatus]]   | [[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]]   |    | This property gets and sets the result status of the transaction.   |
-==== Protected Properties ====
+== Parameters ==
-^ Name ^ Return ^ DeclaringType ^ Summary ^
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} Equals(Object) **
-==== Public Events ====
+  * //N/A//
-^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^
+== Remarks ==
+  * //N/A//
-===== Public Constructors =====
+== Return Value ==
-==== TransactionResult() ====
+  * Type:Boolean
-This is the class constructor.
+  * Description:N/A
-=== Overloads ===
-This is the default constructor and is typically not used.
-=== Remarks ===
-This is the default constructor and is typically not used.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-[[#Public Constructors|Go Back]]
+== Parameters ==
-==== TransactionResult(Int32, Int32, Dictionary<String, String>, TransactionResultStatus) ====
+  * //obj//
-This is the class constructor.
+    * Type:Object
-=== Overloads ===
+    * Description:N/A
-This is the constructor for this class allows you pass in the necessary properties in the class.
-=== Parameters ===
-^  Name ^  Type ^  Description ^
-| totalSuccessCount   | Int32<!-- System.Int32 -->   |    |
-| totalFailureCount   | Int32<!-- System.Int32 -->   |    |
-| failureReasons   | Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} -->   |    |
-| transactionResultStatus   | [[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]]<!-- ThinkGeo.MapSuite.Core.TransactionResultStatus -->   |    |
-[[#Public Constructors|Go Back]]
+<div newline></div>
-===== Protected Constructors =====
+** {{wiki:PublicMethod.gif|}} GetHashCode() **
-===== Public Methods =====
-==== Equals(Object) ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Boolean<!-- System.Boolean -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
-| obj   | Object<!-- System.Object -->   |    |
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Int32
-==== GetHashCode() ====
+  * Description:N/A
-=== Return Value ===
-^ Return Type ^ Description ^
-| Int32<!-- System.Int32 -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+** {{wiki:PublicMethod.gif|}} GetType() **
-<!-- System.Object -->
+  * //N/A//
-[[#Public Methods|Go Back]]
+== Remarks ==
-==== GetType() ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Type<!-- System.Type -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Type
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Public Methods|Go Back]]
+<div newline></div>
-==== ToString() ====
+==== Protected Methods ====
-=== Return Value ===
+** {{wiki:ProtectedMethod.gif|}} Finalize() **
-^ Return Type ^ Description ^
-| String<!-- System.String -->   |    |
-=== Parameters ===
+  * //N/A//
-^  Name ^  Type ^  Description ^
+== Remarks ==
+  * //N/A//
-<!-- System.Object -->
+== Return Value ==
-[[#Public Methods|Go Back]]
+  * Type:Void
-===== Protected Methods =====
+  * Description:N/A
-==== Finalize() ====
-=== Return Value ===
-^ Return Type ^ Description ^
-| Void<!-- System.Void -->   |    |
-=== Parameters ===
+== Parameters ==
-^  Name ^  Type ^  Description ^
+<div newline></div>
+** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() **
-<!-- System.Object -->
+  * //N/A//
-[[#Protected Methods|Go Back]]
+== Remarks ==
-==== MemberwiseClone() ====
+  * //N/A//
-=== Return Value ===
-^ Return Type ^ Description ^
-| Object<!-- System.Object -->   |    |
-=== Parameters ===
+== Return Value ==
-^  Name ^  Type ^  Description ^
+  * Type:Object
+  * Description:N/A
-<!-- System.Object -->
+== Parameters ==
-[[#Protected Methods|Go Back]]
+<div newline></div>
-===== Public Properties =====
+==== Public Properties ====
-==== FailureReasons ====
+** {{wiki:PublicProperty.gif|}} TotalSuccessCount **
-This property gets and sets the dictionary that contains the reasons for failure.
-=== Remarks ===
+This property gets and sets the total number of records that we committed successfully.
-If there are failing records we suggest you add the failure reasons to this dictionary. It is also suggested that you use the FeatureId as the key of the Dictionary.
+== Remarks ==
-=== Return Value ===
+None
-^ Return Type ^
+== Return Value ==
-| Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} -->   |
+  * Type:Int32
+** {{wiki:PublicProperty.gif|}} TotalFailureCount **
-<!-- ThinkGeo.MapSuite.Core.TransactionResult -->
-[[#Public Properties|Go Back]]
-==== TotalFailureCount ====
 This property gets and sets the total number of records that we committed unsuccessfully.
-=== Return Value ===
+== Remarks ==
-^ Return Type ^
+None
-| Int32<!-- System.Int32 -->   |
+== Return Value ==
+  * Type:Int32
-<!-- ThinkGeo.MapSuite.Core.TransactionResult -->
+** {{wiki:PublicProperty.gif|}} TransactionResultStatus **
-[[#Public Properties|Go Back]]
-==== TotalSuccessCount ====
-This property gets and sets the total number of records that we committed successfully.
-=== Return Value ===
-^ Return Type ^
-| Int32<!-- System.Int32 -->   |
-<!-- ThinkGeo.MapSuite.Core.TransactionResult -->
-[[#Public Properties|Go Back]]
-==== TransactionResultStatus ====
 This property gets and sets the result status of the transaction.
-=== Remarks ===
+== Remarks ==
 This property returns the results of the transaction. If all of the records committed fine then you get a success status. If any of the records fail then you get a failure status though some of the records may have committed.
-=== Return Value ===
+== Return Value ==
-^ Return Type ^
+  * Type:[[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]]
-| [[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]]<!-- ThinkGeo.MapSuite.Core.TransactionResultStatus -->   |
-<!-- ThinkGeo.MapSuite.Core.TransactionResult -->
+** {{wiki:PublicProperty.gif|}} FailureReasons **
-[[#Public Properties|Go Back]]
-===== Protected Properties =====
+This property gets and sets the dictionary that contains the reasons for failure.
-===== Public Events =====
+== Remarks ==
-__NOTOC__
+If there are failing records we suggest you add the failure reasons to this dictionary. It is also suggested that you use the FeatureId as the key of the Dictionary.
-[[Category:MapSuiteCore]]
+== Return Value ==
-[[Category:ThinkGeo.MapSuite.Core]]
+  * Type:Dictionary<String,String>
-[[Category:UpdateDocumentation]]
+==== Protected Properties ====
+==== Public Events ====

User Tools

Site Tools

Differences

Page Tools