Interface IEntityLoadConfigurationBuilder

Current version: 4.0

A builder for instances of IEntityLoadConfiguration.

Namespace: StylelabsStylelabs.MStylelabs.M.FrameworkStylelabs.M.Framework.EssentialsLoadConfigurations
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public interface IEntityLoadConfigurationBuilder

Methods

Build()

Gets the resulting instance of IEntityLoadConfiguration.

Declaration
RequestResponse
IEntityLoadConfiguration Build()
Returns
TypeDescription
IEntityLoadConfiguration

The builder.

InCulture(CultureInfo)

Indicates that entities should be loaded in the specified culture.

Declaration
RequestResponse
IEntityLoadConfigurationBuilder InCulture(CultureInfo culture)
Parameters
TypeNameDescription
CultureInfoculture

The culture.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

InCultures(params CultureInfo[])

Indicates that entities should be loaded in the specified cultures.

Declaration
RequestResponse
IEntityLoadConfigurationBuilder InCultures(params CultureInfo[] cultures)
Parameters
TypeNameDescription
CultureInfocultures

The cultures.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

InCultures(IEnumerable<CultureInfo>)

Indicates that entities should be loaded in the specified cultures.

Declaration
RequestResponse
IEntityLoadConfigurationBuilder InCultures(IEnumerable<CultureInfo> cultures)
Parameters
TypeNameDescription
IEnumerable<>CultureInfocultures

The cultures.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

InCultures(LoadOption)

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

Declaration
RequestResponse
IEntityLoadConfigurationBuilder InCultures(LoadOption loadOption)
Parameters
TypeNameDescription
LoadOptionloadOption

The load option.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithProperties(IEnumerable<string>)

Indicates that entities should be loaded with the specified properties.

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithProperties(IEnumerable<string> properties)
Parameters
TypeNameDescription
IEnumerable<>stringproperties

The properties.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithProperties(LoadOption)

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

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithProperties(LoadOption loadOption)
Parameters
TypeNameDescription
LoadOptionloadOption

The load option.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithProperties(params string[])

Indicates that entities should be loaded with the specified properties.

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithProperties(params string[] properties)
Parameters
TypeNameDescription
stringproperties

The properties.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithProperty(string)

Indicates that entities should be loaded with the specified property.

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithProperty(string property)
Parameters
TypeNameDescription
stringproperty

The property.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithRelation(string, RelationRole?)

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

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithRelation(string relation, RelationRole? role)
Parameters
TypeNameDescription
stringrelation

The relation.

RelationRolerole

The role.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithRelation(string)

Indicates that entities should be loaded with the specified relation.

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithRelation(string relation)
Parameters
TypeNameDescription
stringrelation

The relations.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithRelations(IEnumerable<RelationSpecification>)

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

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithRelations(IEnumerable<RelationSpecification> specifications)
Parameters
TypeNameDescription
IEnumerable<>RelationSpecificationspecifications

The specifications.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithRelations(IEnumerable<string>)

Indicates that entities should be loaded with the specified relations.

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithRelations(IEnumerable<string> relations)
Parameters
TypeNameDescription
IEnumerable<>stringrelations

The relations.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithRelations(LoadOption)

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

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithRelations(LoadOption loadOption)
Parameters
TypeNameDescription
LoadOptionloadOption

The load option.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithRelations(params RelationSpecification[])

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

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithRelations(params RelationSpecification[] specifications)
Parameters
TypeNameDescription
RelationSpecificationspecifications

The specifications.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

WithRelations(params string[])

Indicates that entities should be loaded with the specified relations.

Declaration
RequestResponse
IEntityLoadConfigurationBuilder WithRelations(params string[] relations)
Parameters
TypeNameDescription
stringrelations

The relations.

Returns
TypeDescription
IEntityLoadConfigurationBuilder

The builder.

Do you have some feedback for us?

If you have suggestions for improving this article,