Documentation Index Fetch the complete documentation index at: https://easyaf.dev/llms.txt
Use this file to discover all available pages before exploring further.
Definition Assembly: Microsoft.OData.Mcp.Core.dllNamespace: Microsoft.OData.Mcp.Core.ModelsInheritance: System.ObjectSyntax Microsoft . OData . Mcp . Core . Models . EdmModel
Summary Represents a complete OData Entity Data Model (EDM).
The EDM defines the structure of data exposed by an OData service, including entity types,
complex types, entity containers, and their relationships. This class serves as the root
model that contains all metadata necessary to understand and interact with an OData service.
Constructors Initializes a new instance of the EdmModel class.
Syntax Initializes a new instance of the EdmModel class with the specified version.
Syntax public EdmModel ( string version )
Parameters Name Type Description versionstringThe version of the EDM.
Exceptions Exception Description ArgumentExceptionThrown when version is null or whitespace.
Inherited Syntax Properties Gets or sets the actions defined in this model.
Syntax public System . Collections . Generic . List < Microsoft . OData . Mcp . Core . Models . EdmAction > Actions { get ; set ; }
Property Value Type: System.Collections.Generic.List<Microsoft.OData.Mcp.Core.Models.EdmAction>
A collection of actions that can be invoked on the service.
Actions are operations that may have side effects and are used to modify
data or perform operations that cannot be expressed through standard CRUD operations.
Gets all entity sets from all entity containers.
Syntax public System . Collections . Generic . IEnumerable < Microsoft . OData . Mcp . Core . Models . EdmEntitySet > AllEntitySets { get ; }
Property Value Type: System.Collections.Generic.IEnumerable<Microsoft.OData.Mcp.Core.Models.EdmEntitySet>
A flattened collection of all entity sets in the model.
Gets all singletons from all entity containers.
Syntax public System . Collections . Generic . IEnumerable < Microsoft . OData . Mcp . Core . Models . EdmSingleton > AllSingletons { get ; }
Property Value Type: System.Collections.Generic.IEnumerable<Microsoft.OData.Mcp.Core.Models.EdmSingleton>
A flattened collection of all singletons in the model.
Gets or sets the annotations for this model.
Syntax public System . Collections . Generic . Dictionary < string , object > Annotations { get ; set ; }
Property Value Type: System.Collections.Generic.Dictionary<string, object>
A dictionary of annotations that provide additional metadata about the model.
Annotations can be used to specify additional behaviors, constraints, or metadata
that are not captured by the standard OData model elements.
Gets or sets the complex types defined in this model.
Syntax public System . Collections . Generic . List < Microsoft . OData . Mcp . Core . Models . EdmComplexType > ComplexTypes { get ; set ; }
Property Value Type: System.Collections.Generic.List<Microsoft.OData.Mcp.Core.Models.EdmComplexType>
A collection of complex types that define reusable structured data elements.
Complex types are structured types without keys that can be used as property types
in entity types or other complex types.
Gets the primary entity container for this model (alias for PrimaryContainer).
Syntax public Microsoft . OData . Mcp . Core . Models . EdmEntityContainer EntityContainer { get ; }
Property Value Type: Microsoft.OData.Mcp.Core.Models.EdmEntityContainer?
The first entity container, or null if no containers are defined.
Gets or sets the entity containers defined in this model.
Syntax public System . Collections . Generic . List < Microsoft . OData . Mcp . Core . Models . EdmEntityContainer > EntityContainers { get ; set ; }
Property Value Type: System.Collections.Generic.List<Microsoft.OData.Mcp.Core.Models.EdmEntityContainer>
A collection of entity containers that define the service interface.
Entity containers define the addressable resources in the OData service.
Typically, there is one primary entity container per service.
Gets or sets the entity types defined in this model.
Syntax public System . Collections . Generic . List < Microsoft . OData . Mcp . Core . Models . EdmEntityType > EntityTypes { get ; set ; }
Property Value Type: System.Collections.Generic.List<Microsoft.OData.Mcp.Core.Models.EdmEntityType>
A collection of entity types that define the structure of entities in the service.
Entity types are the primary structural elements in the EDM, defining the properties
and relationships that make up the data model.
Gets or sets the functions defined in this model.
Syntax public System . Collections . Generic . List < Microsoft . OData . Mcp . Core . Models . EdmFunction > Functions { get ; set ; }
Property Value Type: System.Collections.Generic.List<Microsoft.OData.Mcp.Core.Models.EdmFunction>
A collection of functions that can be called on the service.
Functions are operations that can be called to retrieve data or perform calculations.
They are side-effect free and can be composed with other query operations.
Gets a value indicating whether this model has any complex types.
Syntax public bool HasComplexTypes { get ; }
Property Value Type: bool
true if the model has complex types; otherwise, false.
Gets a value indicating whether this model has any entity containers.
Syntax public bool HasEntityContainers { get ; }
Property Value Type: bool
true if the model has entity containers; otherwise, false.
Gets a value indicating whether this model has any entity types.
Syntax public bool HasEntityTypes { get ; }
Property Value Type: bool
true if the model has entity types; otherwise, false.
Gets or sets the namespaces used in this model.
Syntax public System . Collections . Generic . List < string > Namespaces { get ; set ; }
Property Value Type: System.Collections.Generic.List<string>
A collection of namespace strings that organize the types in the model.
Namespaces provide organizational structure and help avoid naming conflicts
between types from different sources.
Gets the primary entity container for this model.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmEntityContainer PrimaryContainer { get ; }
Property Value Type: Microsoft.OData.Mcp.Core.Models.EdmEntityContainer?
The first entity container, or null if no containers are defined.
Most OData services have a single entity container that serves as the primary
interface. This property provides convenient access to that container.
Gets or sets the version of the EDM.
Syntax public string Version { get ; set ; }
Property Value Type: string
The version string (e.g., “4.0”, “4.01”).
This indicates which version of the OData standard the model conforms to.
Different versions have different capabilities and syntax.
Methods Adds an annotation to this model.
Syntax public void AddAnnotation ( string term , object value )
Parameters Name Type Description termstringThe annotation term. valueobjectThe annotation value.
Exceptions Exception Description ArgumentExceptionThrown when term is null or whitespace.
Adds a complex type to the model.
Syntax public void AddComplexType ( Microsoft . OData . Mcp . Core . Models . EdmComplexType complexType )
Parameters Name Type Description complexTypeMicrosoft.OData.Mcp.Core.Models.EdmComplexTypeThe complex type to add.
Exceptions Exception Description ArgumentNullExceptionThrown when complexType is null. InvalidOperationExceptionThrown when a complex type with the same full name already exists.
Adds an entity container to the model.
Syntax public void AddEntityContainer ( Microsoft . OData . Mcp . Core . Models . EdmEntityContainer entityContainer )
Parameters Name Type Description entityContainerMicrosoft.OData.Mcp.Core.Models.EdmEntityContainerThe entity container to add.
Exceptions Exception Description ArgumentNullExceptionThrown when entityContainer is null. InvalidOperationExceptionThrown when an entity container with the same full name already exists.
Adds an entity type to the model.
Syntax public void AddEntityType ( Microsoft . OData . Mcp . Core . Models . EdmEntityType entityType )
Parameters Name Type Description entityTypeMicrosoft.OData.Mcp.Core.Models.EdmEntityTypeThe entity type to add.
Exceptions Exception Description ArgumentNullExceptionThrown when entityType is null. InvalidOperationExceptionThrown when an entity type with the same full name already exists.
Inherited Virtual Syntax public virtual bool Equals ( object obj )
Parameters Name Type Description objobject?-
Returns Type: bool
Inherited Syntax public static bool Equals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Gets an annotation value by term.
Syntax public T GetAnnotation < T >( string term )
Parameters Name Type Description termstringThe annotation term.
Returns Type: T?
The annotation value, or the default value of T if not found.
Type Parameters
T - The type of the annotation value.
Gets a complex type by its fully qualified name.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmComplexType GetComplexType ( string fullName )
Parameters Name Type Description fullNamestringThe fully qualified name of the complex type (namespace.name).
Returns Type: Microsoft.OData.Mcp.Core.Models.EdmComplexType?
The complex type with the specified name, or null if not found.
Gets a complex type by name and namespace.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmComplexType GetComplexType ( string name , string namespace )
Parameters Name Type Description namestringThe name of the complex type. namespacestringThe namespace of the complex type.
Returns Type: Microsoft.OData.Mcp.Core.Models.EdmComplexType?
The complex type with the specified name and namespace, or null if not found.
Gets an entity container by its fully qualified name.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmEntityContainer GetEntityContainer ( string fullName )
Parameters Name Type Description fullNamestringThe fully qualified name of the entity container (namespace.name).
Returns Type: Microsoft.OData.Mcp.Core.Models.EdmEntityContainer?
The entity container with the specified name, or null if not found.
Gets an entity container by name and namespace.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmEntityContainer GetEntityContainer ( string name , string namespace )
Parameters Name Type Description namestringThe name of the entity container. namespacestringThe namespace of the entity container.
Returns Type: Microsoft.OData.Mcp.Core.Models.EdmEntityContainer?
The entity container with the specified name and namespace, or null if not found.
Gets an entity set by name from any entity container.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmEntitySet GetEntitySet ( string entitySetName )
Parameters Name Type Description entitySetNamestringThe name of the entity set.
Returns Type: Microsoft.OData.Mcp.Core.Models.EdmEntitySet?
The entity set with the specified name, or null if not found.
Gets an entity type by its fully qualified name.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmEntityType GetEntityType ( string fullName )
Parameters Name Type Description fullNamestringThe fully qualified name of the entity type (namespace.name).
Returns Type: Microsoft.OData.Mcp.Core.Models.EdmEntityType?
The entity type with the specified name, or null if not found.
Gets an entity type by name and namespace.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmEntityType GetEntityType ( string name , string namespace )
Parameters Name Type Description namestringThe name of the entity type. namespacestringThe namespace of the entity type.
Returns Type: Microsoft.OData.Mcp.Core.Models.EdmEntityType?
The entity type with the specified name and namespace, or null if not found.
Inherited Virtual Syntax public virtual int GetHashCode ()
Returns Type: int
Gets a singleton by name from any entity container.
Syntax public Microsoft . OData . Mcp . Core . Models . EdmSingleton GetSingleton ( string singletonName )
Parameters Name Type Description singletonNamestringThe name of the singleton.
Returns Type: Microsoft.OData.Mcp.Core.Models.EdmSingleton?
The singleton with the specified name, or null if not found.
Inherited Syntax public System . Type GetType ()
Returns Type: System.Type
Inherited Syntax protected internal object MemberwiseClone ()
Returns Type: object
Inherited Syntax public static bool ReferenceEquals ( object objA , object objB )
Parameters Name Type Description objAobject?- objBobject?-
Returns Type: bool
Override Returns a string representation of the model.
Syntax public override string ToString ()
Returns Type: string
A summary of the model contents.
Inherited Virtual Syntax public virtual string ToString ()
Returns Type: string?
Validates the model for consistency and completeness.
Syntax public System . Collections . Generic . IEnumerable < string > Validate ()
Returns Type: System.Collections.Generic.IEnumerable<string>
A collection of validation errors, or an empty collection if the model is valid. 
