This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
thinkgeo.mapsuite.core.transactionresult [2015/09/17 10:41] admin |
thinkgeo.mapsuite.core.transactionresult [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.Core.TransactionResult ====== | ====== ThinkGeo.MapSuite.Core.TransactionResult ====== | ||
+ | |||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
+ | |||
This class represents the results of a transaction that was processed. | This class represents the results of a transaction that was processed. | ||
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
Line 5: | Line 8: | ||
***ThinkGeo.MapSuite.Core.TransactionResult** | ***ThinkGeo.MapSuite.Core.TransactionResult** | ||
===== Members Summary ===== | ===== Members Summary ===== | ||
- | === Public Constructors === | + | ==== Public Constructors ==== |
- | <div class_table> | + | ** {{wiki:PublicMethod.gif|}} TransactionResult() ** |
- | **{{wiki:PublicMethod.gif|}}[[#TransactionResult()|TransactionResult]]** | + | |
- | * **Parameters**:N/A | + | |
- | * **DeclaringType**:N/A | + | |
- | * **Summary**:This is the class constructor. | + | |
- | </div> | + | |
- | <div class_table> | + | * //This is the class constructor.// |
- | **{{wiki:PublicMethod.gif|}}[[#TransactionResult(Int32,Int32,Dictionary<String,String>,TransactionResultStatus)|TransactionResult]]** | + | == Remarks == |
- | * **Parameters**:Int32,Int32,Dictionary<String,String>,[[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]] | + | * //This is the default constructor and is typically not used.// |
- | * **DeclaringType**:N/A | + | == Parameters == |
- | * **Summary**:N/A | + | <div newline></div> |
- | </div> | + | ** {{wiki:PublicMethod.gif|}} TransactionResult(Int32,Int32,Dictionary<String,String>,TransactionResultStatus) ** |
- | === Protected Constructors === | + | * //N/A// |
- | === Public Methods === | + | == Remarks == |
- | <div class_table> | + | * //N/A// |
- | **{{wiki:PublicMethod.gif|}}[[#Equals(Object)|Equals]]** | + | == Parameters == |
- | * **Parameters**:Object | + | * //totalSuccessCount// |
- | * **DeclaringType**:Object | + | * Type:Int32 |
- | * **Summary**:N/A | + | * Description:N/A |
- | </div> | + | |
- | <div class_table> | + | * //totalFailureCount// |
- | **{{wiki:PublicMethod.gif|}}[[#GetHashCode()|GetHashCode]]** | + | * Type:Int32 |
- | * **Parameters**:N/A | + | * Description:N/A |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //failureReasons// |
- | **{{wiki:PublicMethod.gif|}}[[#GetType()|GetType]]** | + | * Type:Dictionary<String,String> |
- | * **Parameters**:N/A | + | * Description:N/A |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //transactionResultStatus// |
- | **{{wiki:PublicMethod.gif|}}[[#ToString()|ToString]]** | + | * Type:[[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]] |
- | * **Parameters**:N/A | + | * Description:N/A |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Protected Methods === | + | <div newline></div> |
- | <div class_table> | + | ==== Protected Constructors ==== |
- | **{{wiki:ProtectedMethod.gif|}}[[#Finalize()|Finalize]]** | + | ==== Public Methods ==== |
- | * **Parameters**:N/A | + | ** {{wiki:PublicMethod.gif|}} ToString() ** |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | <div class_table> | + | * //N/A// |
- | **{{wiki:ProtectedMethod.gif|}}[[#MemberwiseClone()|MemberwiseClone]]** | + | == Remarks == |
- | * **Parameters**:N/A | + | * //N/A// |
- | * **DeclaringType**:Object | + | |
- | * **Summary**:N/A | + | |
- | </div> | + | |
- | === Public Properties === | + | == Return Value == |
- | **{{wiki:PublicProperty.gif|}}[[#FailureReasons|FailureReasons]]** | + | * Type:String |
- | * **Return**:Dictionary<String,String> | + | * Description:N/A |
- | * **Summary**:This property gets and sets the dictionary that contains the reasons for failure. | + | |
- | **{{wiki:PublicProperty.gif|}}[[#TotalFailureCount|TotalFailureCount]]** | + | == Parameters == |
- | * **Return**:Int32 | + | <div newline></div> |
- | * **Summary**:This property gets and sets the total number of records that we committed unsuccessfully. | + | ** {{wiki:PublicMethod.gif|}} Equals(Object) ** |
- | **{{wiki:PublicProperty.gif|}}[[#TotalSuccessCount|TotalSuccessCount]]** | + | * //N/A// |
- | * **Return**:Int32 | + | == Remarks == |
- | * **Summary**:This property gets and sets the total number of records that we committed successfully. | + | * //N/A// |
- | **{{wiki:PublicProperty.gif|}}[[#TransactionResultStatus|TransactionResultStatus]]** | + | == Return Value == |
- | * **Return**:[[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]] | + | * Type:Boolean |
- | * **Summary**:This property gets and sets the result status of the transaction. | + | * Description:N/A |
- | === Protected Properties === | + | == Parameters == |
- | === Public Events === | + | * //obj// |
- | ===== Public Constructors ===== | + | * Type:Object |
- | === TransactionResult() === | + | * Description:N/A |
- | This is the class constructor. | + | |
- | ==== Remarks ==== | + | |
- | This is the default constructor and is typically not used. | + | |
- | ==== Parameters ==== | + | |
- | [[#Public Constructors|Go Back]] | + | |
- | === TransactionResult(Int32,Int32,Dictionary<String,String>,TransactionResultStatus) === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | ==== Parameters ==== | + | |
- | **totalSuccessCount** | + | |
- | * **Type**:Int32 | + | |
- | * **Description:N/A | + | |
- | **totalFailureCount** | + | <div newline></div> |
- | * **Type**:Int32 | + | ** {{wiki:PublicMethod.gif|}} GetHashCode() ** |
- | * **Description:N/A | + | |
- | **failureReasons** | + | * //N/A// |
- | * **Type**:Dictionary<String,String> | + | == Remarks == |
- | * **Description:N/A | + | * //N/A// |
- | **transactionResultStatus** | + | == Return Value == |
- | * **Type**:[[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]] | + | * Type:Int32 |
- | * **Description:N/A | + | * Description:N/A |
- | [[#Public Constructors|Go Back]] | + | == Parameters == |
- | ===== Protected Constructors ===== | + | <div newline></div> |
- | ===== Public Methods ===== | + | ** {{wiki:PublicMethod.gif|}} GetType() ** |
- | === Equals(Object) === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Boolean | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | **obj** | + | * Type:Type |
- | * **Type**:Object | + | * Description:N/A |
- | * **Description**:N/A | + | |
- | [[#Public Methods|Go Back]] | + | == Parameters == |
- | === GetHashCode() === | + | <div newline></div> |
- | N/A | + | ==== Protected Methods ==== |
- | ==== Remarks ==== | + | ** {{wiki:ProtectedMethod.gif|}} Finalize() ** |
- | N/A | + | |
- | **Return Value** | + | * //N/A// |
- | * **Return Type**:Int32 | + | == Remarks == |
- | * **Description**:N/A | + | * //N/A// |
- | ==== Parameters ==== | + | == Return Value == |
- | [[#Public Methods|Go Back]] | + | * Type:Void |
- | === GetType() === | + | * Description:N/A |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Parameters == |
- | * **Return Type**:Type | + | <div newline></div> |
- | * **Description**:N/A | + | ** {{wiki:ProtectedMethod.gif|}} MemberwiseClone() ** |
- | ==== Parameters ==== | + | * //N/A// |
- | [[#Public Methods|Go Back]] | + | == Remarks == |
- | === ToString() === | + | * //N/A// |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | == Return Value == |
- | * **Return Type**:String | + | * Type:Object |
- | * **Description**:N/A | + | * Description:N/A |
- | ==== Parameters ==== | + | == Parameters == |
- | [[#Public Methods|Go Back]] | + | <div newline></div> |
- | ===== Protected Methods ===== | + | ==== Public Properties ==== |
- | === Finalize() === | + | ** {{wiki:PublicProperty.gif|}} TotalSuccessCount ** |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | This property gets and sets the total number of records that we committed successfully. |
- | * **Return Type**:Void | + | == Remarks == |
- | * **Description**:N/A | + | None |
- | + | == Return Value == | |
- | ==== Parameters ==== | + | * Type:Int32 |
- | [[#Protected Methods|Go Back]] | + | |
- | === MemberwiseClone() === | + | |
- | N/A | + | |
- | ==== Remarks ==== | + | |
- | N/A | + | |
- | **Return Value** | + | ** {{wiki:PublicProperty.gif|}} TotalFailureCount ** |
- | * **Return Type**:Object | + | |
- | * **Description**:N/A | + | |
- | ==== Parameters ==== | ||
- | [[#Protected Methods|Go Back]] | ||
- | ===== Public Properties ===== | ||
- | === FailureReasons === | ||
- | This property gets and sets the dictionary that contains the reasons for failure. | ||
- | ==== Remarks ==== | ||
- | 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. | ||
- | ==== Return Value ==== | ||
- | **Return Type**:Dictionary<String,String> | ||
- | |||
- | [[#Public Properties|Go Back]] | ||
- | === TotalFailureCount === | ||
This property gets and sets the total number of records that we committed unsuccessfully. | This property gets and sets the total number of records that we committed unsuccessfully. | ||
- | ==== Remarks ==== | + | == Remarks == |
None | None | ||
- | ==== Return Value ==== | + | == Return Value == |
- | **Return Type**:Int32 | + | * Type:Int32 |
- | [[#Public Properties|Go Back]] | + | ** {{wiki:PublicProperty.gif|}} TransactionResultStatus ** |
- | === TotalSuccessCount === | + | |
- | This property gets and sets the total number of records that we committed successfully. | + | |
- | ==== Remarks ==== | + | |
- | None | + | |
- | ==== Return Value ==== | + | |
- | **Return Type**:Int32 | + | |
- | [[#Public Properties|Go Back]] | ||
- | === TransactionResultStatus === | ||
This property gets and sets the result status of the transaction. | 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. | 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**:[[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]] | + | * Type:[[ThinkGeo.MapSuite.Core.TransactionResultStatus|TransactionResultStatus]] |
+ | |||
+ | ** {{wiki:PublicProperty.gif|}} FailureReasons ** | ||
+ | |||
+ | This property gets and sets the dictionary that contains the reasons for failure. | ||
+ | == Remarks == | ||
+ | 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. | ||
+ | == Return Value == | ||
+ | * Type:Dictionary<String,String> | ||
- | [[#Public Properties|Go Back]] | + | ==== Protected Properties ==== |
- | ===== Protected Properties ===== | + | ==== Public Events ==== |
- | ===== Public Events ===== | + | |