DataEntity Class

Object used to describe the results of the query from the Connector. Defines the result of the query. Connectors populate this with the resultant object graph.

Inheritance Hierarchy

System Object

  Scribe.Core.ConnectorApi DataEntity

Namespace:  Scribe.Core.ConnectorApi
Assembly:  Scribe.Core.ConnectorApi (in Scribe.Core.ConnectorApi.dll)

Syntax

[DataContractAttribute]
[KnownTypeAttribute(typeof(EntityProperties))]
[KnownTypeAttribute(typeof(EntityChildren))]
[KnownTypeAttribute(typeof(DBNull))]
[KnownTypeAttribute(typeof(byte[]))]
[KnownTypeAttribute(typeof(DateTime))]
[KnownTypeAttribute(typeof(DateTimeOffset))]
[KnownTypeAttribute(typeof(short))]
[KnownTypeAttribute(typeof(List<Object>))]
[KnownTypeAttribute(typeof(List<string>))]
[KnownTypeAttribute(typeof(List<bool>))]
[KnownTypeAttribute(typeof(List<bool>))]
[KnownTypeAttribute(typeof(List<DateTime>))]
[KnownTypeAttribute(typeof(List<Guid>))]
[KnownTypeAttribute(typeof(List<int>))]
[KnownTypeAttribute(typeof(List<uint>))]
[KnownTypeAttribute(typeof(List<short>))]
[KnownTypeAttribute(typeof(List<ushort>))]
[KnownTypeAttribute(typeof(List<double>))]
[KnownTypeAttribute(typeof(List<long>))]
[KnownTypeAttribute(typeof(List<ulong>))]
[KnownTypeAttribute(typeof(List<float>))]
[KnownTypeAttribute(typeof(List<decimal>))]
[KnownTypeAttribute(typeof(List<decimal>))]
[KnownTypeAttribute(typeof(List<char>))]
[KnownTypeAttribute(typeof(List<DataEntity>))]
public class DataEntity

The DataEntity type exposes the following members.

Constructors

 

Name

Description

Public method

DataEntity

Initializes a new instance of the DataEntity class. Default Ctor

Public method

DataEntity(String)

Initializes a new instance of the DataEntity class. Ctor of the resultEntity node

Properties

 

Name

Description

Public property

Children

Children of this Entity. These are defined by a parent child relationship ie. Foreign

Public property

Id

This property holds a unique identifier for the DataEntity. It is used by Scribe Online Core for referential integrity.

Public property

ObjectDefinitionFullName

Represents the Entities Full Name or logical name for query results.

Public property

Properties

Represents the properties on this entity

Methods

 

Name

Description

Public method

CalculateSizeInBytes

Calculates the in memory size of the data entity in bytes.

Public method Static member

Clone

Clones the specified original data entity.

Public method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

Protected method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

Public method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

Public method Static member

GetProperty(DataEntity, String, Int32)

This method will attempt to get a property from the passed in DataEntity based on the passed in propertyPath.

Public method Static member

GetProperty(DataEntity, String, Int32 )

This method will attempt to get a property from the passed in DataEntity based on the passed in propertyPath.

Public method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Protected method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Public method Static member

SetProperty

This method will attempt to set a property value to a DataEntity based on the passed in property path and child index.

Public method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

See

Scribe.Core.ConnectorApi Namespace