1. Stylelabs.M.Framework.Essentials.LoadConfigurations

Interface IEntityLoadConfigurationBuilder

A builder for instances of IEntityLoadConfiguration.

Namespace: StylelabsStylelabs.MStylelabs.M.FrameworkStylelabs.M.Framework.EssentialsLoadConfigurations

Assembly: Stylelabs.M.Sdk.dll

Syntax

public interface IEntityLoadConfigurationBuilder

Methods

Build()

Gets the resulting instance of IEntityLoadConfiguration.

Declaration

IEntityLoadConfiguration Build()

Returns

TypeDescription
IEntityLoadConfigurationThe builder.

InCulture(CultureInfo)

Indicates that entities should be loaded in the specified culture.

Declaration

IEntityLoadConfigurationBuilder InCulture(CultureInfo culture)

Parameters

TypeNameDescription
CultureInfocultureThe culture.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

InCultures(params CultureInfo[])

Indicates that entities should be loaded in the specified cultures.

Declaration

IEntityLoadConfigurationBuilder InCultures(params CultureInfo[] cultures)

Parameters

TypeNameDescription
CultureInfoculturesThe cultures.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

InCultures(IEnumerable)

Indicates that entities should be loaded in the specified cultures.

Declaration

IEntityLoadConfigurationBuilder InCultures(IEnumerable<CultureInfo> cultures)

Parameters

TypeNameDescription
IEnumerable<>CultureInfoculturesThe cultures.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

InCultures(LoadOption)

Indicates that entities should be loaded int the cultures specified by LoadOption.

Declaration

IEntityLoadConfigurationBuilder InCultures(LoadOption loadOption)

Parameters

TypeNameDescription
LoadOptionloadOptionThe load option.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithProperties(IEnumerable)

Indicates that entities should be loaded with the specified properties.

Declaration

IEntityLoadConfigurationBuilder WithProperties(IEnumerable<string> properties)

Parameters

TypeNameDescription
IEnumerable<>stringpropertiesThe properties.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithProperties(LoadOption)

Indicates that entities should be loaded with the properties specified by loadOption.

Declaration

IEntityLoadConfigurationBuilder WithProperties(LoadOption loadOption)

Parameters

TypeNameDescription
LoadOptionloadOptionThe load option.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithProperties(params string[])

Indicates that entities should be loaded with the specified properties.

Declaration

IEntityLoadConfigurationBuilder WithProperties(params string[] properties)

Parameters

TypeNameDescription
stringpropertiesThe properties.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithProperty(string)

Indicates that entities should be loaded with the specified property.

Declaration

IEntityLoadConfigurationBuilder WithProperty(string property)

Parameters

TypeNameDescription
stringpropertyThe property.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithRelation(string, RelationRole?)

Indicates that entities should be loaded with the specified relation in the specified role.

Declaration

IEntityLoadConfigurationBuilder WithRelation(string relation, RelationRole? role)

Parameters

TypeNameDescription
stringrelationThe relation.
RelationRoleroleThe role.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithRelation(string)

Indicates that entities should be loaded with the specified relation.

Declaration

IEntityLoadConfigurationBuilder WithRelation(string relation)

Parameters

TypeNameDescription
stringrelationThe relations.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithRelations(IEnumerable)

Indicates that entities should be loaded with the relations specified by specifications.

Declaration

IEntityLoadConfigurationBuilder WithRelations(IEnumerable<RelationSpecification> specifications)

Parameters

TypeNameDescription
IEnumerable<>RelationSpecificationspecificationsThe specifications.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithRelations(IEnumerable)

Indicates that entities should be loaded with the specified relations.

Declaration

IEntityLoadConfigurationBuilder WithRelations(IEnumerable<string> relations)

Parameters

TypeNameDescription
IEnumerable<>stringrelationsThe relations.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithRelations(LoadOption)

Indicates that entities should be loaded with the properties specified by loadOption.

Declaration

IEntityLoadConfigurationBuilder WithRelations(LoadOption loadOption)

Parameters

TypeNameDescription
LoadOptionloadOptionThe load option.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithRelations(params RelationSpecification[])

Indicates that entities should be loaded with the relations specified by specifications.

Declaration

IEntityLoadConfigurationBuilder WithRelations(params RelationSpecification[] specifications)

Parameters

TypeNameDescription
RelationSpecificationspecificationsThe specifications.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.

WithRelations(params string[])

Indicates that entities should be loaded with the specified relations.

Declaration

IEntityLoadConfigurationBuilder WithRelations(params string[] relations)

Parameters

TypeNameDescription
stringrelationsThe relations.

Returns

TypeDescription
IEntityLoadConfigurationBuilderThe builder.
If you have suggestions for improving this article, let us know!