-
Notifications
You must be signed in to change notification settings - Fork 0
DiGi.BDL.Classes
Attribute used to categorize a field with a specific identifier and name.
public class Category : System.AttributeInheritance System.Object → System.Attribute → Category
Initializes a new instance of the Category class with a specified identifier, resolving the name automatically.
public Category(string? id);The unique identifier for the category.
Initializes a new instance of the Category class with a specified identifier and name.
public Category(string? id, string? name);The unique identifier for the category.
name System.String
The descriptive name for the category.
Gets the unique identifier of the category.
public string? Id { get; }Gets the descriptive name of the category.
public string? Name { get; }Specifies that a field belongs to a particular group.
public class Group : System.AttributeInheritance System.Object → System.Attribute → Group
Initializes a new instance of the Group class with a specified identifier.
public Group(string? id);The unique identifier for the group.
Initializes a new instance of the Group class with a specified identifier and name.
public Group(string? id, string? name);The unique identifier for the group.
name System.String
The descriptive name for the group.
Gets the unique identifier of the group.
public string? Id { get; }Gets the display name of the group.
public string? Name { get; }Represents a collection of navigation links typically used for pagination in response objects.
public class Links : DiGi.BDL.Interfaces.IResponseObject, DiGi.BDL.Interfaces.IBDLObjectInheritance System.Object → Links
Implements DiGi.BDL.Interfaces.IResponseObject, DiGi.BDL.Interfaces.IBDLObject
Gets or sets the URI for the first page of results.
public string? first { get; set; }Gets or sets the URI for the last page of results.
public string? last { get; set; }Gets or sets the URI for the next page of results.
public string? next { get; set; }Gets or sets the URI for the current page of results.
public string? self { get; set; }Attribute used to define a set of identifiers for a field.
public class PKOB : System.AttributeInheritance System.Object → System.Attribute → PKOB
Initializes a new instance of the PKOB class with a single identifier.
public PKOB(short id);id System.Int16
The identifier to assign.
Initializes a new instance of the PKOB class with a range of identifiers.
public PKOB(short from, short to);from System.Int16
The starting identifier of the range.
to System.Int16
The ending identifier of the range.
Initializes a new instance of the PKOB class with an array of identifiers.
public PKOB(short[]? ids);ids System.Int16[]
The array of identifiers to assign.
Initializes a new instance of the PKOB class with a collection of identifiers.
public PKOB(System.Collections.Generic.IEnumerable<short>? ids);ids System.Collections.Generic.IEnumerable<System.Int16>
The enumerable collection of identifiers to assign.
Gets the collection of identifiers associated with this attribute.
public System.Collections.Generic.HashSet<short>? Ids { get; }System.Collections.Generic.HashSet<System.Int16>
Represents a generic base response object that encapsulates result data and metadata.
public abstract class Response<TResultObject> : DiGi.BDL.Interfaces.IResponseObject, DiGi.BDL.Interfaces.IBDLObject
where TResultObject : DiGi.BDL.Interfaces.IResultObjectTResultObject
The type of the result object, which must implement DiGi.BDL.Interfaces.IResultObject.
Inheritance System.Object → Response<TResultObject>
Derived
↳ UnitsResponse
↳ UnitYearlyValuesResponse
Implements DiGi.BDL.Interfaces.IResponseObject, DiGi.BDL.Interfaces.IBDLObject
Gets or sets the navigation links associated with the response.
public DiGi.BDL.Classes.Links? links { get; set; }Gets or sets the list of result objects contained in the response.
public System.Collections.Generic.List<TResultObject>? results { get; set; }System.Collections.Generic.List<TResultObject>
Gets or sets the total number of records available.
public int totalRecords { get; set; }Attribute used to categorize fields into a specific subgroup.
public class SubGroup : System.AttributeInheritance System.Object → System.Attribute → SubGroup
Initializes a new instance of the SubGroup class with a specified identifier. The name is automatically resolved using the provided identifier.
public SubGroup(string? id);The unique identifier for the subgroup.
Initializes a new instance of the SubGroup class with a specified identifier and name.
public SubGroup(string? id, string? name);The unique identifier for the subgroup.
name System.String
The descriptive name for the subgroup.
Gets the unique identifier of the subgroup.
public string? Id { get; }Gets the descriptive name of the subgroup.
public string? Name { get; }Represents a unit entity that implements the IResultObject interface.
public class Unit : DiGi.BDL.Interfaces.IResultObject, DiGi.BDL.Interfaces.IBDLObjectInheritance System.Object → Unit
Implements DiGi.BDL.Interfaces.IResultObject, DiGi.BDL.Interfaces.IBDLObject
Gets or sets a value indicating whether the unit has an associated description.
public bool hasDescription { get; set; }Gets or sets the unique identifier of the unit.
public string? id { get; set; }Gets or sets the level associated with the unit.
public short level { get; set; }Gets or sets the name of the unit.
public string? name { get; set; }Represents the response object for unit-related queries, including pagination details.
public class UnitsResponse : DiGi.BDL.Classes.Response<DiGi.BDL.Classes.Unit>Inheritance System.Object → DiGi.BDL.Classes.Response<Unit> → UnitsResponse
Gets or sets the current page number of the results.
public int page { get; set; }Gets or sets the number of items per page.
public int pageSize { get; set; }Represents a data model containing yearly values associated with a specific unit.
public class UnitYearlyValues : DiGi.BDL.Interfaces.IBDLObjectInheritance System.Object → UnitYearlyValues
Implements DiGi.BDL.Interfaces.IBDLObject
Gets or sets the identifier for the aggregate group.
public int aggregateId { get; set; }Gets or sets the list of yearly value results associated with the unit.
public System.Collections.Generic.List<DiGi.BDL.Classes.YearlyValues>? results { get; set; }System.Collections.Generic.List<YearlyValues>
Gets or sets the unique identifier of the unit.
public string? unitId { get; set; }Gets or sets the name of the unit.
public string? unitName { get; set; }Represents a response containing yearly values for a specific unit.
public class UnitYearlyValuesResponse : DiGi.BDL.Classes.Response<DiGi.BDL.Classes.YearlyValues>Inheritance System.Object → DiGi.BDL.Classes.Response<YearlyValues> → UnitYearlyValuesResponse
Gets or sets the identifier of the aggregate associated with these values.
public int aggregateId { get; set; }Gets or sets the unique identifier of the unit.
public string? unitId { get; set; }Gets or sets the name of the unit.
public string? unitName { get; set; }Represents a data object containing a value associated with a specific year and attribute identifier.
public class YearlyValue : DiGi.BDL.Interfaces.IBDLObjectInheritance System.Object → YearlyValue
Implements DiGi.BDL.Interfaces.IBDLObject
Gets or sets the unique identifier of the attribute associated with this value.
public int attrId { get; set; }Gets or sets the numeric value for the specified year and attribute.
public double val { get; set; }Gets or sets the year string associated with the value.
public string? year { get; set; }Represents a set of yearly values associated with a specific measurement unit and identifier.
public class YearlyValues : DiGi.BDL.Interfaces.IResultObject, DiGi.BDL.Interfaces.IBDLObjectInheritance System.Object → YearlyValues
Implements DiGi.BDL.Interfaces.IResultObject, DiGi.BDL.Interfaces.IBDLObject
Gets or sets the unique identifier for the yearly values record.
public int id { get; set; }Gets or sets the date and time when the yearly values were last updated.
public System.DateTime lastUpdate { get; set; }Gets or sets the identifier of the measurement unit used for these values.
public int measureUnitId { get; set; }Gets or sets the list of individual yearly value entries.
public System.Collections.Generic.List<DiGi.BDL.Classes.YearlyValue>? values { get; set; }