Class WMDocumentIndexDTO

Data Transfer Object proxy for a WMDocumentIndex.

Inheritance
object
DataTransferObject<WMDocumentIndex>
WMAssetBaseDTO<WMDocumentIndex>
WMDocumentIndexDTO
Implements
Inherited Members
Namespace: Quantellia.WMServer.Asset.DocumentIndex
Assembly: WMServer.dll
Syntax
public class WMDocumentIndexDTO : WMAssetBaseDTO<WMDocumentIndex>, IWMAssetBaseDTO, IDbEntity, IWMEntity

Constructors

WMDocumentIndexDTO()

Constructor for DTO

Declaration
public WMDocumentIndexDTO()

WMDocumentIndexDTO(string)

Constructor for DTO, with specified ID

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

Methods

Create(WMPrincipal, WMDocumentIndexDTO, WMAppDbContext, string, string)

Create a new WMDocumentIndexDTO from the provided data.

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

The owner of the data reader
WMDocumentIndexDTO a_dto

The WMDocumentIndexDTO 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<WMDocumentIndex>
Exceptions
Type Condition
Exception

Delete(WMPrincipal, string, WMAppDbContext)

Delete the WMDocumentIndexDTO with the corresponding ID or FullPathName

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 WMDocumentIndexDTO to be deleted.
WMAppDbContext context

The DbContext
Returns
Type Description
Task
Exceptions
Type Condition
Exception

FromModel()

Create this instance by reading properties from the model.

Declaration
public override void FromModel()
Overrides

Get(WMPrincipal, string, WMAppDbContext?)

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

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

Get(WMPrincipal, string?, int, WMAppDbContext?)

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

Declaration
public static Task<IEnumerable<WMDocumentIndexDTO>> 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 WMDocumentIndexDTO
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<WMDocumentIndexDTO>>

GetAssociatedDocuments(WMPrincipal, string, WMAppDbContext)

Returns a list of all documents associated with this vector index

Declaration
public static Task<IEnumerable<WMDocumentDTO>> GetAssociatedDocuments(WMPrincipal principal, string dir, WMAppDbContext context)
Parameters
Type Name Description
WMPrincipal principal
string dir
WMAppDbContext context
Returns
Type Description
Task<IEnumerable<WMDocumentDTO>>

GetFromDirectory(WMPrincipal, string, int, WMAppDbContext)

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

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

The owner of the data readers being requested.
string dir

Specification of the directory under which to retrieve WMDocumentIndexDTO
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<WMDocumentIndexDTO>>

Update(WMPrincipal, string, WMDocumentIndexDTO, WMAppDbContext)

Updates the specified WMDocumentIndexDTO from the provided data.

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

The owner of the directory
string id

The id or fullpath of the directory
WMDocumentIndexDTO a_dto

The WMDocumentIndexDTO to be updated.
WMAppDbContext context

The DbContext
Returns
Type Description
Task
Exceptions
Type Condition
Exception

UpdateModel(WMPrincipal, DbContext, object[]?)

Updates and returns the contained model.

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

Implements