C# Class Sage.SData.Client.Core.SDataService

Service class for processing SData Request
Inheritance: ISDataService, ISDataRequestSettings
Mostra file Open project: Saleslogix/SDataCSharpClientLib Class Usage Examples

Private Properties

Property Type Description
ExecuteEntryRequest Sage.SData.Client.Atom.AtomEntry
ExecuteFeedRequest Sage.SData.Client.Atom.AtomFeed
Initialize void
ReadSchema Sage.SData.Client.Metadata.SDataSchemaObject

Public Methods

Method Description
CreateAsync ( Sage.SData.Client.Core.SDataBaseRequest request, ISyndicationResource resource ) : AsyncRequest

Asynchronous PUT to the server

CreateEntry ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomEntry entry ) : Sage.SData.Client.Atom.AtomEntry

Adds a new syndication resource to the data source.

CreateFeed ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomFeed feed ) : Sage.SData.Client.Atom.AtomFeed

Adds a new syndication resource to the data source.

CreateFeed ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomFeed feed, string &eTag ) : Sage.SData.Client.Atom.AtomFeed

Adds a new syndication resource to the data source.

Delete ( string url ) : bool

Generic delete from server

DeleteEntry ( Sage.SData.Client.Core.SDataBaseRequest request ) : bool

Removes a resource from the syndication data source.

DeleteEntry ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomEntry entry ) : bool

Removes a resource from the syndication data source.

Read ( string url ) : object

generic read from the specified url

ReadAsync ( string url, object userState ) : void
ReadEntry ( Sage.SData.Client.Core.SDataBaseRequest request ) : Sage.SData.Client.Atom.AtomEntry

Reads resource information from the data source based on the URL.

ReadEntry ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomEntry entry ) : Sage.SData.Client.Atom.AtomEntry

Reads resource information from the data source based on the URL and the ETag of the specified entry.

ReadFeed ( Sage.SData.Client.Core.SDataBaseRequest request ) : Sage.SData.Client.Atom.AtomFeed

Reads resource information from the data source based on the URL.

ReadFeed ( Sage.SData.Client.Core.SDataBaseRequest request, string &eTag ) : Sage.SData.Client.Atom.AtomFeed

Reads resource information from the data source based on the URL and the specified ETag.

ReadSchema ( Sage.SData.Client.Core.SDataResourceSchemaRequest request ) : Sage.SData.Client.Metadata.SDataSchemaObject

Reads xsd from a $schema request

SDataService ( ) : System

Initialises a new instance of the SDataService class.

SDataService ( string url ) : System

Initialises a new instance of the SDataService class, initialized with a target url.

SDataService ( string url, string userName, string password ) : System

Initialises a new instance of the SDataService class, initialized with a target url, user name and password.

UpdateEntry ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomEntry entry ) : Sage.SData.Client.Atom.AtomEntry

Updates information about a syndication resource in the data source.

Protected Methods

Method Description
ExecuteRequest ( string url, RequestOperation operation ) : ISDataResponse

Private Methods

Method Description
ExecuteEntryRequest ( string url, RequestOperation operation ) : Sage.SData.Client.Atom.AtomEntry
ExecuteFeedRequest ( string url, RequestOperation operation, string &eTag ) : Sage.SData.Client.Atom.AtomFeed
Initialize ( ) : void
ReadSchema ( ISDataResponse response ) : Sage.SData.Client.Metadata.SDataSchemaObject

Method Details

CreateAsync() public method

Asynchronous PUT to the server
public CreateAsync ( Sage.SData.Client.Core.SDataBaseRequest request, ISyndicationResource resource ) : AsyncRequest
request Sage.SData.Client.Core.SDataBaseRequest The request that identifies the resource within the syndication data source.
resource ISyndicationResource The resource that should be created asynchronously.
return AsyncRequest

CreateEntry() public method

Adds a new syndication resource to the data source.
public CreateEntry ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomEntry entry ) : Sage.SData.Client.Atom.AtomEntry
request Sage.SData.Client.Core.SDataBaseRequest The request that identifies the resource within the syndication data source.
entry Sage.SData.Client.Atom.AtomEntry The entry that should be created.
return Sage.SData.Client.Atom.AtomEntry

CreateFeed() public method

Adds a new syndication resource to the data source.
public CreateFeed ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomFeed feed ) : Sage.SData.Client.Atom.AtomFeed
request Sage.SData.Client.Core.SDataBaseRequest The request that identifies the resource within the syndication data source.
feed Sage.SData.Client.Atom.AtomFeed
return Sage.SData.Client.Atom.AtomFeed

CreateFeed() public method

Adds a new syndication resource to the data source.
public CreateFeed ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomFeed feed, string &eTag ) : Sage.SData.Client.Atom.AtomFeed
request Sage.SData.Client.Core.SDataBaseRequest
feed Sage.SData.Client.Atom.AtomFeed
eTag string
return Sage.SData.Client.Atom.AtomFeed

Delete() public method

Generic delete from server
public Delete ( string url ) : bool
url string the url for the operation
return bool

DeleteEntry() public method

Removes a resource from the syndication data source.
public DeleteEntry ( Sage.SData.Client.Core.SDataBaseRequest request ) : bool
request Sage.SData.Client.Core.SDataBaseRequest
return bool

DeleteEntry() public method

Removes a resource from the syndication data source.
public DeleteEntry ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomEntry entry ) : bool
request Sage.SData.Client.Core.SDataBaseRequest The request from the syndication data source for the resource to be removed.
entry Sage.SData.Client.Atom.AtomEntry the resource that is being deleted
return bool

ExecuteRequest() protected method

protected ExecuteRequest ( string url, RequestOperation operation ) : ISDataResponse
url string
operation Sage.SData.Client.Framework.RequestOperation
return ISDataResponse

Read() public method

generic read from the specified url
public Read ( string url ) : object
url string url to read from
return object

ReadAsync() public method

public ReadAsync ( string url, object userState ) : void
url string
userState object
return void

ReadEntry() public method

Reads resource information from the data source based on the URL.
public ReadEntry ( Sage.SData.Client.Core.SDataBaseRequest request ) : Sage.SData.Client.Atom.AtomEntry
request Sage.SData.Client.Core.SDataBaseRequest Request for the syndication resource to get information for.
return Sage.SData.Client.Atom.AtomEntry

ReadEntry() public method

Reads resource information from the data source based on the URL and the ETag of the specified entry.
public ReadEntry ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomEntry entry ) : Sage.SData.Client.Atom.AtomEntry
request Sage.SData.Client.Core.SDataBaseRequest
entry Sage.SData.Client.Atom.AtomEntry
return Sage.SData.Client.Atom.AtomEntry

ReadFeed() public method

Reads resource information from the data source based on the URL.
public ReadFeed ( Sage.SData.Client.Core.SDataBaseRequest request ) : Sage.SData.Client.Atom.AtomFeed
request Sage.SData.Client.Core.SDataBaseRequest request for the syndication resource to get information for.
return Sage.SData.Client.Atom.AtomFeed

ReadFeed() public method

Reads resource information from the data source based on the URL and the specified ETag.
public ReadFeed ( Sage.SData.Client.Core.SDataBaseRequest request, string &eTag ) : Sage.SData.Client.Atom.AtomFeed
request Sage.SData.Client.Core.SDataBaseRequest
eTag string
return Sage.SData.Client.Atom.AtomFeed

ReadSchema() public method

Reads xsd from a $schema request
public ReadSchema ( Sage.SData.Client.Core.SDataResourceSchemaRequest request ) : Sage.SData.Client.Metadata.SDataSchemaObject
request Sage.SData.Client.Core.SDataResourceSchemaRequest url for the syndication resource to get information for.
return Sage.SData.Client.Metadata.SDataSchemaObject

SDataService() public method

Initialises a new instance of the SDataService class.
public SDataService ( ) : System
return System

SDataService() public method

Initialises a new instance of the SDataService class, initialized with a target url.
public SDataService ( string url ) : System
url string
return System

SDataService() public method

Initialises a new instance of the SDataService class, initialized with a target url, user name and password.
public SDataService ( string url, string userName, string password ) : System
url string
userName string user name used for credentials
password string password for user
return System

UpdateEntry() public method

Updates information about a syndication resource in the data source.
public UpdateEntry ( Sage.SData.Client.Core.SDataBaseRequest request, Sage.SData.Client.Atom.AtomEntry entry ) : Sage.SData.Client.Atom.AtomEntry
request Sage.SData.Client.Core.SDataBaseRequest The url from the syndication data source for the resource to be updated.
entry Sage.SData.Client.Atom.AtomEntry /// An object that implements the interface that represents the updated information for the resource. ///
return Sage.SData.Client.Atom.AtomEntry