C# Class Nettiers.AdventureWorks.Data.WebServiceClient.WsContactProviderBase

This class is the webservice client implementation that exposes CRUD methods for Nettiers.AdventureWorks.Entities.Contact objects.

Inheritance: ContactProviderBase

ファイルを表示 Open project: netTiers/netTiers

Public Methods

Method	Description
BulkInsert ( TransactionManager transactionManager, Nettiers entityList ) : void	Lets you efficiently bulk many entity to the database. After inserting into the datasource, the Nettiers.AdventureWorks.Entities.Contact object will be updated to refelect any changes made by the datasource. (ie: identity or computed columns)
Convert ( Nettiers outItem, WsProxy item ) : Contact	Convert a nettiers collection to the ws proxy collection.
Convert ( WsProxy item ) : Contact	Convert a nettiers collection to the ws proxy collection.
Convert ( WsProxy items ) : Nettiers.AdventureWorks.Entities.TList	Convert a collection from the ws proxy to a nettiers collection.
Convert ( Nettiers item ) : WsProxy.Contact	Convert a nettiers entity to the ws proxy entity.
Convert ( Nettiers items ) : WsProxy.Contact[]	Convert a collection from to a nettiers collection to a the ws proxy collection.
Delete ( TransactionManager transactionManager, System _contactId ) : bool	Deletes based on primary key(s).
Find ( TransactionManager transactionManager, string whereClause, int start, int pagelen, int &count ) : Nettiers.AdventureWorks.Entities.TList	Returns rows meeting the whereclause condition from the DataSource. Operators must be capitalized (OR, AND)
GetAll ( TransactionManager transactionManager, int start, int pageLength, int &count ) : Nettiers.AdventureWorks.Entities.TList	Gets All rows from the DataSource.
GetByAdditionalContactInfo ( TransactionManager transactionManager, string _additionalContactInfo, int start, int pageLength, int &count ) : Nettiers.AdventureWorks.Entities.TList	Gets rows from the datasource based on the PXML_Contact_AddContact index.
GetByContactId ( TransactionManager transactionManager, System _contactId, int start, int pageLength, int &count ) : Contact	Gets rows from the datasource based on the PK_Contact_ContactID index.
GetByCreditCardIdFromContactCreditCard ( TransactionManager transactionManager, System _creditCardId, int start, int pagelen, int &count ) : TList	Gets Contact objects from the datasource by CreditCardID in the ContactCreditCard table. Table Contact is related to table CreditCard through the (M:N) relationship defined in the ContactCreditCard table.
GetByCustomerIdFromStoreContact ( TransactionManager transactionManager, System _customerId, int start, int pagelen, int &count ) : TList	Gets Contact objects from the datasource by CustomerID in the StoreContact table. Table Contact is related to table Store through the (M:N) relationship defined in the StoreContact table.
GetByEmailAddress ( TransactionManager transactionManager, System _emailAddress, int start, int pageLength, int &count ) : Nettiers.AdventureWorks.Entities.TList	Gets rows from the datasource based on the IX_Contact_EmailAddress index.
GetByRowguid ( TransactionManager transactionManager, System _rowguid, int start, int pageLength, int &count ) : Contact	Gets rows from the datasource based on the AK_Contact_rowguid index.
GetByVendorIdFromVendorContact ( TransactionManager transactionManager, System _vendorId, int start, int pagelen, int &count ) : TList	Gets Contact objects from the datasource by VendorID in the VendorContact table. Table Contact is related to table Vendor through the (M:N) relationship defined in the VendorContact table.
GetPaged ( TransactionManager transactionManager, string whereClause, string orderBy, int start, int pageLength, int &count ) : Nettiers.AdventureWorks.Entities.TList	Gets a page of rows from the DataSource.
Insert ( TransactionManager transactionManager, Nettiers entity ) : bool	Inserts a Nettiers.AdventureWorks.Entities.Contact object into the datasource using a transaction.
Update ( TransactionManager transactionManager, Nettiers entity ) : bool	Update an existing row in the datasource.
WsContactProviderBase ( ) : System	Creates a new WsContactProviderBase instance. Uses connection string to connect to datasource.
WsContactProviderBase ( string url ) : System	Creates a new WsContactProviderBase instance. Uses connection string to connect to datasource.

Method Details

BulkInsert() public method

Lets you efficiently bulk many entity to the database.

After inserting into the datasource, the Nettiers.AdventureWorks.Entities.Contact object will be updated to refelect any changes made by the datasource. (ie: identity or computed columns)

public BulkInsert ( TransactionManager transactionManager, Nettiers entityList ) : void
transactionManager	TransactionManager	NOTE: The transaction manager should be null for the web service client implementation.
entityList	Nettiers	The entities.
return	void

Convert() public static method

Convert a nettiers collection to the ws proxy collection.

public static Convert ( Nettiers outItem, WsProxy item ) : Contact
outItem	Nettiers
item	WsProxy
return	Nettiers.AdventureWorks.Entities.Contact

Convert() public static method

Convert a nettiers collection to the ws proxy collection.

public static Convert ( WsProxy item ) : Contact
item	WsProxy
return	Nettiers.AdventureWorks.Entities.Contact

Convert() public static method

Convert a collection from the ws proxy to a nettiers collection.

public static Convert ( WsProxy items ) : Nettiers.AdventureWorks.Entities.TList
items	WsProxy
return	Nettiers.AdventureWorks.Entities.TList

Convert() public static method

Convert a nettiers entity to the ws proxy entity.

public static Convert ( Nettiers item ) : WsProxy.Contact
item	Nettiers
return	WsProxy.Contact

Convert() public static method

Convert a collection from to a nettiers collection to a the ws proxy collection.

public static Convert ( Nettiers items ) : WsProxy.Contact[]
items	Nettiers
return	WsProxy.Contact[]

Delete() public method

Deletes based on primary key(s).

public Delete ( TransactionManager transactionManager, System _contactId ) : bool
transactionManager	TransactionManager	object
_contactId	System
return	bool

Find() public method

Returns rows meeting the whereclause condition from the DataSource.

Operators must be capitalized (OR, AND)

public Find ( TransactionManager transactionManager, string whereClause, int start, int pagelen, int &count ) : Nettiers.AdventureWorks.Entities.TList
transactionManager	TransactionManager	object
whereClause	string	Specifies the condition for the rows returned by a query (Name='John Doe', Name='John Doe' AND Id='1', Name='John Doe' OR Id='1').
start	int	Row number at which to start reading.
pagelen	int	Number of rows to return.
count	int	Number of rows in the DataSource.
return	Nettiers.AdventureWorks.Entities.TList

GetAll() public method

Gets All rows from the DataSource.

public GetAll ( TransactionManager transactionManager, int start, int pageLength, int &count ) : Nettiers.AdventureWorks.Entities.TList
transactionManager	TransactionManager	object
start	int	Row number at which to start reading.
pageLength	int	Number of rows to return.
count	int	out parameter to get total records for query
return	Nettiers.AdventureWorks.Entities.TList

GetByAdditionalContactInfo() public method

Gets rows from the datasource based on the PXML_Contact_AddContact index.

public GetByAdditionalContactInfo ( TransactionManager transactionManager, string _additionalContactInfo, int start, int pageLength, int &count ) : Nettiers.AdventureWorks.Entities.TList
transactionManager	TransactionManager	object
_additionalContactInfo	string	Additional contact information about the person stored in xml format.
start	int	Row number at which to start reading.
pageLength	int	Number of rows to return.
count	int	out parameter to get total records for query
return	Nettiers.AdventureWorks.Entities.TList

GetByContactId() public method

Gets rows from the datasource based on the PK_Contact_ContactID index.

public GetByContactId ( TransactionManager transactionManager, System _contactId, int start, int pageLength, int &count ) : Contact
transactionManager	TransactionManager	object
_contactId	System	Primary key for Contact records.
start	int	Row number at which to start reading.
pageLength	int	Number of rows to return.
count	int	out parameter to get total records for query
return	Nettiers.AdventureWorks.Entities.Contact

GetByCreditCardIdFromContactCreditCard() public method

Gets Contact objects from the datasource by CreditCardID in the ContactCreditCard table. Table Contact is related to table CreditCard through the (M:N) relationship defined in the ContactCreditCard table.

public GetByCreditCardIdFromContactCreditCard ( TransactionManager transactionManager, System _creditCardId, int start, int pagelen, int &count ) : TList
transactionManager	TransactionManager	object
_creditCardId	System	Credit card identification number. Foreign key to CreditCard.CreditCardID.
start	int	Row number at which to start reading.
pagelen	int	Number of rows to return.
count	int	Number of rows in the DataSource.
return	TList

GetByCustomerIdFromStoreContact() public method

Gets Contact objects from the datasource by CustomerID in the StoreContact table. Table Contact is related to table Store through the (M:N) relationship defined in the StoreContact table.

public GetByCustomerIdFromStoreContact ( TransactionManager transactionManager, System _customerId, int start, int pagelen, int &count ) : TList
transactionManager	TransactionManager	object
_customerId	System	Store identification number. Foreign key to Customer.CustomerID.
start	int	Row number at which to start reading.
pagelen	int	Number of rows to return.
count	int	Number of rows in the DataSource.
return	TList

GetByEmailAddress() public method

Gets rows from the datasource based on the IX_Contact_EmailAddress index.

public GetByEmailAddress ( TransactionManager transactionManager, System _emailAddress, int start, int pageLength, int &count ) : Nettiers.AdventureWorks.Entities.TList
transactionManager	TransactionManager	object
_emailAddress	System	E-mail address for the person.
start	int	Row number at which to start reading.
pageLength	int	Number of rows to return.
count	int	out parameter to get total records for query
return	Nettiers.AdventureWorks.Entities.TList

GetByRowguid() public method

Gets rows from the datasource based on the AK_Contact_rowguid index.

public GetByRowguid ( TransactionManager transactionManager, System _rowguid, int start, int pageLength, int &count ) : Contact
transactionManager	TransactionManager	object
_rowguid	System	ROWGUIDCOL number uniquely identifying the record. Used to support a merge replication sample.
start	int	Row number at which to start reading.
pageLength	int	Number of rows to return.
count	int	out parameter to get total records for query
return	Nettiers.AdventureWorks.Entities.Contact

GetByVendorIdFromVendorContact() public method

Gets Contact objects from the datasource by VendorID in the VendorContact table. Table Contact is related to table Vendor through the (M:N) relationship defined in the VendorContact table.

public GetByVendorIdFromVendorContact ( TransactionManager transactionManager, System _vendorId, int start, int pagelen, int &count ) : TList
transactionManager	TransactionManager	object
_vendorId	System	Primary key.
start	int	Row number at which to start reading.
pagelen	int	Number of rows to return.
count	int	Number of rows in the DataSource.
return	TList

GetPaged() public method

Gets a page of rows from the DataSource.

public GetPaged ( TransactionManager transactionManager, string whereClause, string orderBy, int start, int pageLength, int &count ) : Nettiers.AdventureWorks.Entities.TList
transactionManager	TransactionManager	object
whereClause	string	Specifies the condition for the rows returned by a query (Name='John Doe', Name='John Doe' AND Id='1', Name='John Doe' OR Id='1').
orderBy	string	Specifies the sort criteria for the rows in the DataSource (Name ASC; BirthDay DESC, Name ASC);
start	int	Row number at which to start reading.
pageLength	int	Number of rows to return.
count	int	Number of rows in the DataSource.
return	Nettiers.AdventureWorks.Entities.TList

Insert() public method

Inserts a Nettiers.AdventureWorks.Entities.Contact object into the datasource using a transaction.

public Insert ( TransactionManager transactionManager, Nettiers entity ) : bool
transactionManager	TransactionManager	object
entity	Nettiers	Nettiers.AdventureWorks.Entities.Contact object to insert.
return	bool

Update() public method

Update an existing row in the datasource.

public Update ( TransactionManager transactionManager, Nettiers entity ) : bool
transactionManager	TransactionManager	object
entity	Nettiers	Nettiers.AdventureWorks.Entities.Contact object to update.
return	bool

WsContactProviderBase() public method

Creates a new WsContactProviderBase instance. Uses connection string to connect to datasource.

public WsContactProviderBase ( ) : System
return	System

WsContactProviderBase() public method

Creates a new WsContactProviderBase instance. Uses connection string to connect to datasource.

public WsContactProviderBase ( string url ) : System
url	string	The url to the nettiers webservice.
return	System