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
[PrimaryKey("ID", new string[] { "Version" })]
public class WMDocumentIndexDTO : WMAssetBaseDTO<WMDocumentIndex>, IWMAssetBaseDTO, IWMVersionableAsset, IWMOwnableResource, IWMResource, 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

Clone(WMPrincipal, WMAssetIdentifier, VersionCreateArgs?, WMAppDbContext)

Clones the specified asset with an iterated name "AssetName (1), etc... ", iterates the version number.

Declaration
public static Task<WMDocumentIndexDTO> Clone(WMPrincipal principal, WMAssetIdentifier identifier, VersionCreateArgs? args, WMAppDbContext context)
Parameters
Type Name Description
WMPrincipal principal

The owner of the directory
WMAssetIdentifier identifier

The identifier of the directory
VersionCreateArgs args

Arguments for creating a version.
WMAppDbContext context

The DbContext
Returns
Type Description
Task<WMDocumentIndexDTO>
Exceptions
Type Condition
Exception

Commit(WMPrincipal, WMAssetIdentifier, WMAppDbContext)

Commits the specified asset as Head.

Declaration
public static Task Commit(WMPrincipal principal, WMAssetIdentifier identifier, WMAppDbContext context)
Parameters
Type Name Description
WMPrincipal principal

The owner of the directory
WMAssetIdentifier identifier

The identifier of the directory
WMAppDbContext context

The DbContext
Returns
Type Description
Task
Exceptions
Type Condition
Exception

Create(WMPrincipal, WMDocumentIndexDTO, WMAppDbContext)

Create a new WMDocumentIndexDTO from the provided data.

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

The owner of the data reader
WMDocumentIndexDTO a_dto

The WMDocumentIndexDTO to be created.
WMAppDbContext context

The DbContext
Returns
Type Description
Task<WMDocumentIndex>
Exceptions
Type Condition
Exception

Delete(WMPrincipal, WMAssetIdentifier, WMAppDbContext)

Delete the WMDocumentIndexDTO with the corresponding ID or FullPathName

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

The owner of the directory
WMAssetIdentifier identifier

The identifier of the asset
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, WMAssetIdentifier, WMAppDbContext?, Expression<Func<WMDocumentIndexDTO, WMDocumentIndexDTO>>)

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

Declaration
public static Task<WMDocumentIndexDTO> Get(WMPrincipal principal, WMAssetIdentifier identifier, WMAppDbContext? context = null, Expression<Func<WMDocumentIndexDTO, WMDocumentIndexDTO>> propertySelector = null)
Parameters
Type Name Description
WMPrincipal principal
WMAssetIdentifier identifier

The identifier of the asset
WMAppDbContext context
Expression<Func<WMDocumentIndexDTO, WMDocumentIndexDTO>> propertySelector

An optional expression that allows additional mapping of the database DTO object to the instance DTO object. (i.e. excluding DocumentData and DocumentEditedText from WMDocumentDTO, which requires excessive time and bandwidth. An example of this can be found in Get(WMPrincipal, WMAssetIdentifier, WMAppDbContext?, Expression<Func<WMDocumentDTO, WMDocumentDTO>>))
Returns
Type Description
Task<WMDocumentIndexDTO>

GetAssociatedDocuments(WMPrincipal, WMAssetIdentifier, WMAppDbContext)

Returns a list of all documents associated with this vector index

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

The identifier of the asset
WMAppDbContext context
Returns
Type Description
Task<IEnumerable<WMDocumentDTO>>

GetFromDirectory(WMPrincipal, WMAssetIdentifier, int, WMAppDbContext, Expression<Func<WMDocumentIndexDTO, WMDocumentIndexDTO>>)

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, WMAssetIdentifier identifier = null, int recursionDepth = 0, WMAppDbContext context = null, Expression<Func<WMDocumentIndexDTO, WMDocumentIndexDTO>> propertySelector = null)
Parameters
Type Name Description
WMPrincipal principal

The owner of the data readers being requested.
WMAssetIdentifier identifier

The identifier of the asset
int recursionDepth

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

Optional reference to a WMAppDbContext instance.
Expression<Func<WMDocumentIndexDTO, WMDocumentIndexDTO>> propertySelector

An optional expression that allows additional mapping of the database DTO object to the instance DTO object. (i.e. excluding DocumentData and DocumentEditedText from WMDocumentDTO, which requires excessive time and bandwidth. An example of this can be found in Get(WMPrincipal, WMAssetIdentifier, WMAppDbContext?, Expression<Func<WMDocumentDTO, WMDocumentDTO>>))
Returns
Type Description
Task<IEnumerable<WMDocumentIndexDTO>>

ResourceDefinition()

The resource operation definition for this asset.

Declaration
public static WMResourceOperationsDefinition ResourceDefinition()
Returns
Type Description
WMResourceOperationsDefinition

Update(WMPrincipal, WMAssetIdentifier, WMDocumentIndexDTO, WMAppDbContext)

Updates the specified WMDocumentIndexDTO from the provided data.

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

The owner of the directory
WMAssetIdentifier identifier

The identifier of the asset
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

Versions(WMPrincipal, WMAssetIdentifier, WMAppDbContext)

Gets all versions of the specified asset.

Declaration
public static Task<IEnumerable<VersionArgs>> Versions(WMPrincipal principal, WMAssetIdentifier identifier, WMAppDbContext context)
Parameters
Type Name Description
WMPrincipal principal

The owner of the directory
WMAssetIdentifier identifier

The identifier of the directory
WMAppDbContext context

The DbContext
Returns
Type Description
Task<IEnumerable<VersionArgs>>
Exceptions
Type Condition
Exception

Implements