Class WMDataSourceBaseDTO

Data Transfer Object proxy for a WMDataSourceBase.

Inheritance
object
DataTransferObject<WMDataSourceBase>
WMAssetBaseDTO<WMDataSourceBase>
WMDataSourceBaseDTO
Implements
Inherited Members
Namespace: Quantellia.WMServer.Asset.DataSource
Assembly: WMServer.dll
Syntax
public class WMDataSourceBaseDTO : WMAssetBaseDTO<WMDataSourceBase>, IWMAssetBaseDTO, IDbEntity, IWMEntity, IHasEncryptedValues

Constructors

WMDataSourceBaseDTO()

Constructor for WMDataSourceBaseDTO

Declaration
public WMDataSourceBaseDTO()

WMDataSourceBaseDTO(string)

Constructor for WMDataSourceBaseDTO, with specified ID

Declaration
public WMDataSourceBaseDTO(string ID)
Parameters
Type Name Description
string ID

Properties

ConnectionString

The connection string to the database.

Declaration
public string ConnectionString { get; set; }
Property Value
Type Description
string

RegisteredType

The string used to register this data source type in RegisterWMDataSourceType(string, Type)

Declaration
public string RegisteredType { get; set; }
Property Value
Type Description
string

Methods

BuildQuery(string, string, Dictionary<string, object>, string, bool)

Declaration
public static string BuildQuery(string operationType, string tableName, Dictionary<string, object> data, string rowId = null, bool includeSelect = false)
Parameters
Type Name Description
string operationType
string tableName
Dictionary<string, object> data
string rowId
bool includeSelect
Returns
Type Description
string
Exceptions
Type Condition
ArgumentException

Create(WMPrincipal, WMDataSourceBaseDTO, WMAppDbContext, string, string)

Create a new WMDataSourceBaseDTO from the provided data.

Declaration
public static Task<WMDataSourceBase> Create(WMPrincipal principal, WMDataSourceBaseDTO a_dto, WMAppDbContext context, string assetOwnerType, string assetOwnerID)
Parameters
Type Name Description
WMPrincipal principal

The owner of the data source
WMDataSourceBaseDTO a_dto

The WMDataSourceBaseDTO to be created.
WMAppDbContext context

The DbContext
string assetOwnerType

TYpe of the WMPrincipal that owns the Asset.
string assetOwnerID

ID of the WMPrincipal that owns the Asset.
Returns
Type Description
Task<WMDataSourceBase>
Exceptions
Type Condition
Exception

Delete(WMPrincipal, string, WMAppDbContext)

Create a new WMDataSourceBaseDTO from the provided data.

Declaration
public static Task Delete(WMPrincipal principal, string dir, WMAppDbContext context)
Parameters
Type Name Description
WMPrincipal principal

The owner of the directory
string dir

The Id or FullPathName of the corresponding WMDataSourceBaseDTO to be deleted.
WMAppDbContext context

The DbContext
Returns
Type Description
Task
Exceptions
Type Condition
Exception

Evaluate(WMPrincipal, string, DataSourceArgs, WMAppDbContext)

Performs an evaluation on a temporary dataReader one created from the arguments of the body DataSourceArgs, and a supplied data source ID.

Declaration
public static Task<ElementValue> Evaluate(WMPrincipal principal, string dir, DataSourceArgs args, WMAppDbContext context)
Parameters
Type Name Description
WMPrincipal principal
string dir

The directory or ID of the data source to use.
DataSourceArgs args

Arguments for the evaluation
WMAppDbContext context
Returns
Type Description
Task<ElementValue>

FromModel()

Create this instance by reading properties from a WMDataReader

Declaration
public override void FromModel()
Overrides

Get(WMPrincipal, string, WMAppDbContext?)

Gets the WMDataSourceBase instance with the specified id. Ensures ownership.

Declaration
public static Task<WMDataSourceBaseDTO> Get(WMPrincipal principal, string dir, WMAppDbContext? context = null)
Parameters
Type Name Description
WMPrincipal principal
string dir

ID of the data source
WMAppDbContext context
Returns
Type Description
Task<WMDataSourceBaseDTO>

Get(WMPrincipal, string, int, WMAppDbContext)

Gets a listing of the specified WMDataSourceBaseDTO to the recursion depth specified.

Declaration
public static Task<IEnumerable<WMDataSourceBaseDTO>> Get(WMPrincipal principal, string dir = null, int recursionDepth = 0, WMAppDbContext context = null)
Parameters
Type Name Description
WMPrincipal principal

The owner of the Asset Directory being requested.
string dir

Specification of the directory under which to retrieve WMDataSourceBaseDTO
int recursionDepth

Depth to which the directory subtrees under the specified directory should be traversed.
WMAppDbContext context

Optional reference to a WMAppDbContext instance.
Returns
Type Description
Task<IEnumerable<WMDataSourceBaseDTO>>

GetAccessorString(WMPrincipal, string, WMAppDbContext)

Returns the AccessorString belonging to the data source with this ID/dir, otherwise an exception.

Declaration
public static Task<string> GetAccessorString(WMPrincipal principal, string dir = null, WMAppDbContext context = null)
Parameters
Type Name Description
WMPrincipal principal
string dir

The ID or fullPathName of the data source to get.
WMAppDbContext context
Returns
Type Description
Task<string>

GetFromDirectory(WMPrincipal, string, int, WMAppDbContext)

Gets a listing of the specified WMDataSourceBaseDTO to the recursion depth specified with the ID/Dir of a WMAssetDirectory as input.

Declaration
public static Task<IEnumerable<WMDataSourceBaseDTO>> GetFromDirectory(WMPrincipal principal, string dir = null, int recursionDepth = 0, WMAppDbContext context = null)
Parameters
Type Name Description
WMPrincipal principal

The owner of the data sources being requested.
string dir

Specification of the directory under which to retrieve WMDataSourceBaseDTO
int recursionDepth

Depth to which the directory subtrees under the specified directory should be traversed.
WMAppDbContext context

Optional reference to a WMAppDbContext instance.
Returns
Type Description
Task<IEnumerable<WMDataSourceBaseDTO>>

SetAccessorString(WMPrincipal, string, string, WMAppDbContext)

Sets the AccessorString belonging to the data source with this ID/dir, otherwise an exception.

Declaration
public static Task SetAccessorString(WMPrincipal principal, string accessorString, string dir = null, WMAppDbContext context = null)
Parameters
Type Name Description
WMPrincipal principal
string accessorString

The plain-text representation of this data source's accessor string.
string dir

The ID or fullPathName of the data source to get.
WMAppDbContext context
Returns
Type Description
Task

Update(WMPrincipal, string, WMDataSourceBaseDTO, WMAppDbContext)

Updates the specified WMDataSourceBaseDTO from the provided data.

Declaration
public static Task Update(WMPrincipal principal, string id, WMDataSourceBaseDTO a_dto, WMAppDbContext context)
Parameters
Type Name Description
WMPrincipal principal

The owner of the directory
string id

The id or fullpath of the directory
WMDataSourceBaseDTO a_dto

The WMDataSourceBaseDTO to be updated.
WMAppDbContext context

The DbContext
Returns
Type Description
Task
Exceptions
Type Condition
Exception

UpdateModel(WMPrincipal, DbContext, object[]?)

Updates and returns the contained WMDataReader.

Declaration
public override Task<WMDataSourceBase> UpdateModel(WMPrincipal principal, DbContext context, object[]? data = null)
Parameters
Type Name Description
WMPrincipal principal
DbContext context
object[] data
Returns
Type Description
Task<WMDataSourceBase>
Overrides

Implements