This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
thinkgeo.mapsuite.silverlightcore.transactionresult [2015/08/20 03:08] 127.0.0.1 external edit |
thinkgeo.mapsuite.silverlightcore.transactionresult [2017/03/16 21:59] (current) |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== ThinkGeo.MapSuite.SilverlightCore.TransactionResult ====== | ====== ThinkGeo.MapSuite.SilverlightCore.TransactionResult ====== | ||
+ | {{section>upgrade_map_suite_to_10.0}} | ||
- | + | This class represents the results of a transaction that was processed. | |
- | <!-- Class --> | + | |
===== Inheritance Hierarchy ===== | ===== Inheritance Hierarchy ===== | ||
- | *System.Object | + | *System.Object |
- | **[[ThinkGeo.MapSuite.SilverlightCore.TransactionResult]] | + | ***ThinkGeo.MapSuite.SilverlightCore.TransactionResult** |
===== Members Summary ===== | ===== Members Summary ===== | ||
==== Public Constructors ==== | ==== Public Constructors ==== | ||
- | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | + | ** {{wiki:PublicMethod.gif|}} TransactionResult() ** |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#TransactionResult()|TransactionResult]] | | | | | + | |
- | | {{wiki:PublicMethod.gif|Public Method}}[[#TransactionResult(Int32, Int32, Dictionary<String, String>, TransactionResultStatus)|TransactionResult]] | Int32, Int32, Dictionary<String, String>, [[ThinkGeo.MapSuite.SilverlightCore.TransactionResultStatus|TransactionResultStatus]] | | | | + | |
- | ==== 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.SilverlightCore.TransactionResultStatus|TransactionResultStatus]] | ||
+ | * Description:N/A | ||
+ | |||
+ | <div newline></div> | ||
+ | ==== Protected Constructors ==== | ||
==== Public Methods ==== | ==== 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> | | | | + | * Description:N/A |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#TotalFailureCount|TotalFailureCount]] | Int32 | | | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#TotalSuccessCount|TotalSuccessCount]] | Int32 | | | | + | |
- | | {{wiki:PublicProperty.gif|Public Property}}[[#TransactionResultStatus|TransactionResultStatus]] | [[ThinkGeo.MapSuite.SilverlightCore.TransactionResultStatus|TransactionResultStatus]] | | | | + | |
- | ==== 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 |
- | === Parameters === | + | * Description:N/A |
- | ^ Name ^ Type ^ Description ^ | + | |
- | [[#Public Constructors|Go Back]] | + | == Parameters == |
- | ==== TransactionResult(Int32, Int32, Dictionary<String, String>, TransactionResultStatus) ==== | + | * //obj// |
- | === Parameters === | + | * Type:Object |
- | ^ Name ^ Type ^ Description ^ | + | * Description:N/A |
- | | totalSuccessCount | Int32<!-- System.Int32 --> | | | + | |
- | | totalFailureCount | Int32<!-- System.Int32 --> | | | + | |
- | | failureReasons | Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} --> | | | + | |
- | | transactionResultStatus | [[ThinkGeo.MapSuite.SilverlightCore.TransactionResultStatus|TransactionResultStatus]]<!-- ThinkGeo.MapSuite.SilverlightCore.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 ** |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Dictionary<String,String><!-- System.Collections.Generic.Dictionary{System.String,System.String} --> | | + | |
- | <!-- ThinkGeo.MapSuite.SilverlightCore.TransactionResult --> | + | This property gets and sets the total number of records that we committed successfully. |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== TotalFailureCount ==== | + | None |
- | === Return Value === | + | == Return Value == |
- | ^ Return Type ^ | + | * Type:Int32 |
- | | Int32<!-- System.Int32 --> | | + | |
- | <!-- ThinkGeo.MapSuite.SilverlightCore.TransactionResult --> | + | ** {{wiki:PublicProperty.gif|}} TotalFailureCount ** |
- | [[#Public Properties|Go Back]] | + | |
- | ==== TotalSuccessCount ==== | + | |
- | === Return Value === | + | |
- | ^ Return Type ^ | + | |
- | | Int32<!-- System.Int32 --> | | + | |
- | <!-- ThinkGeo.MapSuite.SilverlightCore.TransactionResult --> | + | This property gets and sets the total number of records that we committed unsuccessfully. |
- | [[#Public Properties|Go Back]] | + | == Remarks == |
- | ==== TransactionResultStatus ==== | + | None |
- | === Return Value === | + | == Return Value == |
- | ^ Return Type ^ | + | * Type:Int32 |
- | | [[ThinkGeo.MapSuite.SilverlightCore.TransactionResultStatus|TransactionResultStatus]]<!-- ThinkGeo.MapSuite.SilverlightCore.TransactionResultStatus --> | | + | |
- | <!-- ThinkGeo.MapSuite.SilverlightCore.TransactionResult --> | + | ** {{wiki:PublicProperty.gif|}} TransactionResultStatus ** |
- | [[#Public Properties|Go Back]] | + | |
- | ===== Protected Properties ===== | + | This property gets and sets the result status of the transaction. |
- | ===== Public Events ===== | + | == Remarks == |
- | __NOTOC__ | + | 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. |
- | [[Category:SilverlightMapSuiteCore]] | + | == Return Value == |
- | [[Category:ThinkGeo.MapSuite.SilverlightCore]] | + | * Type:[[ThinkGeo.MapSuite.SilverlightCore.TransactionResultStatus|TransactionResultStatus]] |
- | [[Category:UpdateDocumentation]] | + | |
+ | ** {{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> | ||
+ | |||
+ | ==== Protected Properties ==== | ||
+ | ==== Public Events ==== | ||