thinkgeo.mapsuite.portablecore.transactionresult
Differences
This shows you the differences between two versions of the page.
| Next revision | Previous revision | ||
|
thinkgeo.mapsuite.portablecore.transactionresult [2015/08/20 03:08] 127.0.0.1 external edit |
— (current) | ||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== ThinkGeo.MapSuite.PortableCore.TransactionResult ====== | ||
| - | |||
| - | |||
| - | |||
| - | <!-- 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 | ||
| - | **[[ThinkGeo.MapSuite.PortableCore.TransactionResult]] | ||
| - | ===== Members Summary ===== | ||
| - | ==== Public Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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.PortableCore.TransactionResultStatus|TransactionResultStatus]] | | This is the class constructor. | | ||
| - | |||
| - | ==== Protected Constructors ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Methods ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{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 ==== | ||
| - | ^ Name ^ Parameters ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#Finalize()|Finalize]] | | Object | | | ||
| - | | {{wiki:ProtectedMethod.gif|Protected Method}}[[#MemberwiseClone()|MemberwiseClone]] | | Object | | | ||
| - | |||
| - | ==== Public Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | | {{wiki:PublicProperty.gif|Public Property}}[[#FailureReasons|FailureReasons]] | Dictionary<String,String> | | This property gets and sets the dictionary that contains the reasons for failure. | | ||
| - | | {{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.PortableCore.TransactionResultStatus|TransactionResultStatus]] | | This property gets and sets the result status of the transaction. | | ||
| - | |||
| - | ==== Protected Properties ==== | ||
| - | ^ Name ^ Return ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ==== Public Events ==== | ||
| - | ^ Name ^ Event Arguments ^ DeclaringType ^ Summary ^ | ||
| - | |||
| - | ===== Public Constructors ===== | ||
| - | ==== TransactionResult() ==== | ||
| - | This is the class constructor. | ||
| - | === 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]] | ||
| - | ==== TransactionResult(Int32, Int32, Dictionary<String, String>, TransactionResultStatus) ==== | ||
| - | This is the class constructor. | ||
| - | === Overloads === | ||
| - | 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.PortableCore.TransactionResultStatus|TransactionResultStatus]]<!-- ThinkGeo.MapSuite.PortableCore.TransactionResultStatus --> | | | ||
| - | |||
| - | [[#Public Constructors|Go Back]] | ||
| - | ===== Protected Constructors ===== | ||
| - | ===== Public Methods ===== | ||
| - | ==== Equals(Object) ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Boolean<!-- System.Boolean --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | | obj | Object<!-- System.Object --> | | | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetHashCode() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Int32<!-- System.Int32 --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== GetType() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Type<!-- System.Type --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ==== ToString() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | String<!-- System.String --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Public Methods|Go Back]] | ||
| - | ===== Protected Methods ===== | ||
| - | ==== Finalize() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Void<!-- System.Void --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#Protected Methods|Go Back]] | ||
| - | ==== MemberwiseClone() ==== | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ Description ^ | ||
| - | | Object<!-- System.Object --> | | | ||
| - | |||
| - | === Parameters === | ||
| - | ^ Name ^ Type ^ Description ^ | ||
| - | |||
| - | <!-- System.Object --> | ||
| - | [[#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><!-- System.Collections.Generic.Dictionary{System.String,System.String} --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.TransactionResult --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TotalFailureCount ==== | ||
| - | This property gets and sets the total number of records that we committed unsuccessfully. | ||
| - | === Return Value === | ||
| - | ^ Return Type ^ | ||
| - | | Int32<!-- System.Int32 --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.TransactionResult --> | ||
| - | [[#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.PortableCore.TransactionResult --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ==== TransactionResultStatus ==== | ||
| - | This property gets and sets the result status of the transaction. | ||
| - | === 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 Type ^ | ||
| - | | [[ThinkGeo.MapSuite.PortableCore.TransactionResultStatus|TransactionResultStatus]]<!-- ThinkGeo.MapSuite.PortableCore.TransactionResultStatus --> | | ||
| - | |||
| - | <!-- ThinkGeo.MapSuite.PortableCore.TransactionResult --> | ||
| - | [[#Public Properties|Go Back]] | ||
| - | ===== Protected Properties ===== | ||
| - | ===== Public Events ===== | ||
| - | __NOTOC__ | ||
| - | [[Category:MapSuitePortableCore]] | ||
| - | [[Category:ThinkGeo.MapSuite.PortableCore]] | ||
| - | [[Category:UpdateDocumentation]] | ||
thinkgeo.mapsuite.portablecore.transactionresult.1440040133.txt.gz ยท Last modified: 2015/09/21 08:20 (external edit)
