QueryEntity Class

Defines the properties of a data entity as used within a query.

Inheritance Hierarchy

System Object

  Scribe.Core.ConnectorApi.Query QueryEntity

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

Syntax

[DataContractAttribute]
[KnownTypeAttribute(typeof(Relationship))]
[KnownTypeAttribute(typeof(Sequence))]
public class QueryEntity : IEqualityComparer<QueryEntity>

The QueryEntity type exposes the following members.

Constructors

 

Name

Description

Public method

QueryEntity

Hidden default constructor

Public method

QueryEntity(QueryEntity)

Parent QueryEntity constructor Set parentQueryEntity to NULL for Root Entity

Properties

 

Name

Description

Public property

ChildList

A list of the QueryEntity's child QueryEntitys

Public property

Id

This property holds the unique identifier for this object.

Public property

KeyPropertyList

This field holds the full name of each key property.

Public property

Name

The name of the QueryEntity

Public property

ObjectDefinitionFullName

The Full name of the ObjectDefinition this QueryEntity is based on

Public property

ParentQueryEntity

The QueryEntity's Parent QueryEntity Will be set to NULL if the QueryEntity is the RootQueryEntity

Public property

PropertyList

A list of the Full names of the Properties this QueryEntity exposes of the ObjectDefinition it is based on

Public property

RelationshipToParent

The description of the QueryEntity's relationship to it's Parent QueryEntity Will be set to NULL if the QueryEntity is the RootQueryEntity

Public property

SequenceList

A list of the Properties used to order the data returned for this QueryEntity

Methods

 

 

 

Public method

Equals(Object)

This method will return whether this object and the passed in object are equal.

(Overrides Object Equals(Object).)

Public method

Equals(QueryEntity, QueryEntity)

This method will return whether the two passed in objects are equal.

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

FindQueryEntityByName

This method will return the QueryEntity that matches the passed in name or null if not found. This only searches this object and it's children. If you want to search the entire Query use the FindQueryEntityByName on the Query object itself.

Public method

GetHashCode

This method will return the hashcode of this object.

(Overrides Object GetHashCode .)

Public method

GetHashCode(QueryEntity)

This method will return the hashcode of the passed in object.

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

OnDeserialized

This method will tie this object's children to this parent.

Public method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

See

Scribe.Core.ConnectorApi.Query Namespace