Interface IContentQueryResultMapper

Namespace

CMS.ContentEngine

Assembly

CMS.ContentEngine.dll

Mapper which provides mapping of IContentQueryDataContainer to model.

public interface IContentQueryResultMapper

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

Map<TModel>(IContentQueryDataContainer)

Maps the content query result IContentQueryDataContainer to specified model TModel properties.

TModel Map<TModel>(IContentQueryDataContainer dataContainer) where TModel : new()

Parameters

dataContainer IContentQueryDataContainer

IContentQueryDataContainer containing data to be mapped to the model.

Returns

TModel

TModel Model with mapped data from the dataContainer.

Type Parameters

TModel

Type of returned model.

Remarks

The properties of the TModel model are mapped case insensitive by the name, so their names and types need to match the names and types in dataContainer except for special cases:

• ContentItemFields property is mapped by type.
• For ContentItemAsset field to be properly mapped the dataContainer needs to include also ContentItemGUID.
• Linked items are mapped to System.Collections.Generic.IEnumerable<T> property.

Properties which are not included in the dataContainer will not be mapped.

Exceptions

ArgumentNullException

Thrown when container is null.

InvalidOperationException

Thrown when the data cannot be bound to the model e.g., the types of the properties doesn't match.