Skip to end of metadata
Go to start of metadata

Abstract class for data service classes.

Definition

public class DataServiceBase : IDataService, IDataServiceCache

Summary

The following table summarizes the members exposed in this class.

Public Constructors

DataServiceBase Constructor() Initializes a new instance of the DataServiceBase class.

Public Properties

CacheKeyDependency Gets or sets the unique cache key dependency.
CacheScope Gets or sets the scope of the cache allocation. Global means that the data source control will use the cache in the global scope. PerUser Control means that the data source control will use the cache stored in the particular User Control.
DataObjectTypeName Gets or sets the data object typename that passed along from/to the data service.
EnableCaching Gets or sets a value indicating whether caching is enabled or not.
ReferenceNamespace Gets or sets the reference namespace of the data service.
ServiceHost Gets or sets the targeted host's url (e.g. complete-url = http://www.intersoftpt.com/myservice.svc; service-host: http://www.intersoftpt.com)
ServiceName Gets or sets the value that identify the service object in the data source service collection.
ServiceTarget Gets or sets the targeted data service (e.g. complete-url = http://www.intersoftpt.com/myservice.svc; service-target: myservice.svc)
ServiceTypeName Gets or sets the reference typename of the data service.

Public Methods

GetCacheKeyDependency() Gets cache dependency of this service object. If the service doesn't have cache key dependency definition, it will use the definition from datasource level.
GetCacheScope() Gets the cache scope of this service object. If the value is set to Default, it will use the definition from datasource level.
GetControl() Gets the owner datasource control of this service object.
GetEnableCaching() Gets the value indicating whether caching is enabled or not. If the value is set to Default, it will use the definition from datasource level.
GetReferenceNamespace() Gets the reference namespace of the service object. If the service doesn't have reference namespace definition, it will use the definition from datasource control level.
GetServiceHost() Gets the service host of this service object. If the service doesn't have host definition, it will use the definition from datasource control level.
GetServiceTarget() Gets the service target of this service object. If the service doesn't have target definition, it will use the definition from datasource control level.
GetServiceTypeName() Gets the service typename of the service object. If the service doesn't have service type name definition, it will use the definition from datasource control level.
InvalidateAllCache() Invalidate all current cache allocation.
InvalidateCache(string) Invalidate cache stored with the provided key.
InvalidateCache(string, int, int) Invalidate cache stored with the provided key.

Public Constructors

public DataServiceBase()

Public Properties

public string CacheKeyDependency { get; set; }

Gets or sets the unique cache key dependency.

public CacheScope CacheScope { get; set; }

Gets or sets the scope of the cache allocation. Global means that the data source control will use the cache in the global scope. PerUser Control means that the data source control will use the cache stored in the particular User Control.

public string DataObjectTypeName { get; set; }

Gets or sets the data object typename that passed along from/to the data service.

public BooleanValue EnableCaching { get; set; }

Gets or sets a value indicating whether caching is enabled or not.

public string ReferenceNamespace { get; set; }

Gets or sets the reference namespace of the data service.

public string ServiceHost { get; set; }

Gets or sets the targeted host's url (e.g. complete-url = http://www.intersoftpt.com/myservice.svc; service-host: http://www.intersoftpt.com)

public string ServiceName { get; set; }

Gets or sets the value that identify the service object in the data source service collection.

public string ServiceTarget { get; set; }

Gets or sets the targeted data service (e.g. complete-url = http://www.intersoftpt.com/myservice.svc; service-target: myservice.svc)

public string ServiceTypeName { get; set; }

Gets or sets the reference typename of the data service.

Public Methods

public string GetCacheKeyDependency()

Gets cache dependency of this service object. If the service doesn't have cache key dependency definition, it will use the definition from datasource level.

Return Types

Cache key dependency

public CacheScope GetCacheScope()

Gets the cache scope of this service object. If the value is set to Default, it will use the definition from datasource level.

Return Types

Cache scope

public ISDataSourceControl GetControl()

Gets the owner datasource control of this service object.

Return Types

Datasource Control

public BooleanValue GetEnableCaching()

Gets the value indicating whether caching is enabled or not. If the value is set to Default, it will use the definition from datasource level.

public string GetReferenceNamespace()

Gets the reference namespace of the service object. If the service doesn't have reference namespace definition, it will use the definition from datasource control level.

Return Types

Reference namespace of the service object.

public string GetServiceHost()

Gets the service host of this service object. If the service doesn't have host definition, it will use the definition from datasource control level.

Return Types

Service host of this service object. (e.g. http://www.intersoftpt.com)

public string GetServiceTarget()

Gets the service target of this service object. If the service doesn't have target definition, it will use the definition from datasource control level.

Return Types

Service target of the service object. (e.g. MyService.svc)

public string GetServiceTypeName()

Gets the service typename of the service object. If the service doesn't have service type name definition, it will use the definition from datasource control level.

Return Types

Service typename of the service object.

public void InvalidateAllCache()

Invalidate all current cache allocation.

public void InvalidateCache(string cacheKey)

Invalidate cache stored with the provided key.

Parameters

cacheKey Cache key

public void InvalidateCache(string parentKey, int startRowIndex, int maximumRows)

Invalidate cache stored with the provided key.

Parameters

parentKey Cache key
startRowIndex Start row index
maximumRows Minimum rows
  • No labels