Class QueryLoadConfiguration

Current version: 4.0

Represents a loading configuration for querying ids or entities.

Inheritance
object
QueryLoadConfiguration
Namespace: StylelabsStylelabs.MStylelabs.M.FrameworkStylelabs.M.Framework.EssentialsLoadConfigurations
Assembly: Stylelabs.M.Sdk.dll
Syntax
RequestResponse
public class QueryLoadConfiguration : IQueryLoadConfiguration

Constructors

QueryLoadConfiguration()

Initializes a new instance of the QueryLoadConfiguration class. Loads no entities by default.

Declaration
RequestResponse
public QueryLoadConfiguration()

QueryLoadConfiguration(IQueryLoadConfiguration)

Initializes a new instance of the QueryLoadConfiguration class.

Declaration
RequestResponse
public QueryLoadConfiguration(IQueryLoadConfiguration configuration)
Parameters
TypeNameDescription
IQueryLoadConfigurationconfiguration

The load configuration.

QueryLoadConfiguration(ICultureLoadOption, IPropertyLoadOption, IRelationLoadOption)

Initializes a new instance of the QueryLoadConfiguration class. Loads entities by default.

Declaration
RequestResponse
public QueryLoadConfiguration(ICultureLoadOption cultureOption, IPropertyLoadOption propertyOption, IRelationLoadOption relationOption)
Parameters
TypeNameDescription
ICultureLoadOptioncultureOption

Culture load option.

IPropertyLoadOptionpropertyOption

Property load option.

IRelationLoadOptionrelationOption

Relation load option.

QueryLoadConfiguration(bool, ICultureLoadOption, IPropertyLoadOption, IRelationLoadOption)

Initializes a new instance of the QueryLoadConfiguration class.

Declaration
RequestResponse
public QueryLoadConfiguration(bool loadEntities, ICultureLoadOption cultureOption, IPropertyLoadOption propertyOption, IRelationLoadOption relationOption)
Parameters
TypeNameDescription
boolloadEntities

Load entities.

ICultureLoadOptioncultureOption

Culture load option.

IPropertyLoadOptionpropertyOption

Property load option.

IRelationLoadOptionrelationOption

Relation load option.

Properties

CultureLoadOption

Gets the culture load option.

Declaration
RequestResponse
public ICultureLoadOption CultureLoadOption { get; set; }
Property Value
TypeDescription
ICultureLoadOption

Default

Gets the query result entities in default culture, with all properties and no relations.

Declaration
RequestResponse
public static IQueryLoadConfiguration Default { get; }
Property Value
TypeDescription
IQueryLoadConfiguration

DefaultCultureFull

Gets the query result entities in default culture, with all properties and all relations.

Declaration
RequestResponse
public static IQueryLoadConfiguration DefaultCultureFull { get; }
Property Value
TypeDescription
IQueryLoadConfiguration

Full

Gets the query result entities in all installed cultures, with all properties and all relations.

Declaration
RequestResponse
public static IQueryLoadConfiguration Full { get; }
Property Value
TypeDescription
IQueryLoadConfiguration

Ids

Gets the query result will only contain ids.

Declaration
RequestResponse
public static IQueryLoadConfiguration Ids { get; }
Property Value
TypeDescription
IQueryLoadConfiguration

LoadEntities

Gets a value indicating whether entities or ids need to be returned. If false, no entities will be loaded, and the load options will be ignored.

Declaration
RequestResponse
public bool LoadEntities { get; set; }
Property Value
TypeDescription
bool

Minimal

Gets only the base entity properties.

Declaration
RequestResponse
public static IQueryLoadConfiguration Minimal { get; }
Property Value
TypeDescription
IQueryLoadConfiguration

PropertyLoadOption

Gets the property load option.

Declaration
RequestResponse
public IPropertyLoadOption PropertyLoadOption { get; set; }
Property Value
TypeDescription
IPropertyLoadOption

RelationLoadOption

Gets the relation load option.

Declaration
RequestResponse
public IRelationLoadOption RelationLoadOption { get; set; }
Property Value
TypeDescription
IRelationLoadOption

Implements

Do you have some feedback for us?

If you have suggestions for improving this article,