IEntityLoadConfigurationBuilder

IEntityLoadConfigurationBuilder

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

Type	Description
IEntityLoadConfiguration	The builder.

InCulture(CultureInfo)

Indicates that entities should be loaded in the specified culture.

Declaration

IEntityLoadConfigurationBuilder InCulture(CultureInfo culture)

Parameters

Type	Name	Description
CultureInfo	culture	The culture.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

InCultures(params CultureInfo[])

Indicates that entities should be loaded in the specified cultures.

Declaration

IEntityLoadConfigurationBuilder InCultures(params CultureInfo[] cultures)

Parameters

Type	Name	Description
CultureInfo	cultures	The cultures.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

InCultures(IEnumerable<CultureInfo>)

Indicates that entities should be loaded in the specified cultures.

Declaration

IEntityLoadConfigurationBuilder InCultures(IEnumerable<CultureInfo> cultures)

Parameters

Type	Name	Description
IEnumerable<>CultureInfo	cultures	The cultures.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

InCultures(LoadOption)

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

Declaration

IEntityLoadConfigurationBuilder InCultures(LoadOption loadOption)

Parameters

Type	Name	Description
LoadOption	loadOption	The load option.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithProperties(IEnumerable<string>)

Indicates that entities should be loaded with the specified properties.

Declaration

IEntityLoadConfigurationBuilder WithProperties(IEnumerable<string> properties)

Parameters

Type	Name	Description
IEnumerable<>string	properties	The properties.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithProperties(LoadOption)

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

Declaration

IEntityLoadConfigurationBuilder WithProperties(LoadOption loadOption)

Parameters

Type	Name	Description
LoadOption	loadOption	The load option.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithProperties(params string[])

Indicates that entities should be loaded with the specified properties.

Declaration

IEntityLoadConfigurationBuilder WithProperties(params string[] properties)

Parameters

Type	Name	Description
string	properties	The properties.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithProperty(string)

Indicates that entities should be loaded with the specified property.

Declaration

IEntityLoadConfigurationBuilder WithProperty(string property)

Parameters

Type	Name	Description
string	property	The property.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The 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

Type	Name	Description
string	relation	The relation.
RelationRole	role	The role.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithRelation(string)

Indicates that entities should be loaded with the specified relation.

Declaration

IEntityLoadConfigurationBuilder WithRelation(string relation)

Parameters

Type	Name	Description
string	relation	The relations.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithRelations(IEnumerable<RelationSpecification>)

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

Declaration

IEntityLoadConfigurationBuilder WithRelations(IEnumerable<RelationSpecification> specifications)

Parameters

Type	Name	Description
IEnumerable<>RelationSpecification	specifications	The specifications.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithRelations(IEnumerable<string>)

Indicates that entities should be loaded with the specified relations.

Declaration

IEntityLoadConfigurationBuilder WithRelations(IEnumerable<string> relations)

Parameters

Type	Name	Description
IEnumerable<>string	relations	The relations.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithRelations(LoadOption)

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

Declaration

IEntityLoadConfigurationBuilder WithRelations(LoadOption loadOption)

Parameters

Type	Name	Description
LoadOption	loadOption	The load option.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithRelations(params RelationSpecification[])

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

Declaration

IEntityLoadConfigurationBuilder WithRelations(params RelationSpecification[] specifications)

Parameters

Type	Name	Description
RelationSpecification	specifications	The specifications.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

WithRelations(params string[])

Indicates that entities should be loaded with the specified relations.

Declaration

IEntityLoadConfigurationBuilder WithRelations(params string[] relations)

Parameters

Type	Name	Description
string	relations	The relations.

Returns

Type	Description
IEntityLoadConfigurationBuilder	The builder.

If you have suggestions for improving this article, let us know!