EdmCoreModel Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides predefined declarations relevant to EDM semantics.
public class EdmCoreModel : Microsoft.OData.Edm.EdmElement, Microsoft.OData.Edm.IEdmModeltype EdmCoreModel = class
inherit EdmElement
interface IEdmModel
interface IEdmElementPublic Class EdmCoreModel
Inherits EdmElement
Implements IEdmModel- Inheritance
- Implements
Fields
| Instance |
The default core EDM model. |
Properties
| DeclaredNamespaces |
Gets the collection of namespaces that schema elements use contained in this model. |
| DirectValueAnnotationsManager |
Gets the model's annotations manager. |
| EntityContainer |
Gets the only one entity container of the model. |
| Namespace |
Gets the namespace of this core model. |
| ReferencedModels |
Gets the collection of models referred to by this model. |
| SchemaElements |
Gets the types defined in this core model. |
| VocabularyAnnotations |
Gets the vocabulary annotations defined in this model. |
Methods
| FindDeclaredBoundOperations(IEdmType) |
Searches for bound operations based on the binding type, returns an empty enumerable if no operation exists. |
| FindDeclaredBoundOperations(String, IEdmType) |
Searches for bound operations based on the qualified name and binding type, returns an empty enumerable if no operation exists. |
| FindDeclaredOperations(String) |
Searches for operations with the given name in this model and returns an empty enumerable if no such operation exists. |
| FindDeclaredTerm(String) |
Searches for a term with the given name in this model and returns null if no such term exists. |
| FindDeclaredType(String) |
Searches for a type with the given name in this model only and returns null if no such type exists. |
| FindDeclaredVocabularyAnnotations(IEdmVocabularyAnnotatable) |
Searches for vocabulary annotations specified by this model or a referenced model for a given element. |
| FindDirectlyDerivedTypes(IEdmStructuredType) |
Finds a list of types that derive from the supplied type. |
| FindOperationImportsByNameNonBindingParameterType(String, IEnumerable<String>) |
Searches for any functionImport or actionImport by name and parameter names. |
| GetAnnotationPath(Boolean) |
Gets a reference to the Edm.AnnotationPath type definition. |
| GetBinary(Boolean) |
Gets a reference to a binary primitive type definition. |
| GetBinary(Boolean, Nullable<Int32>, Boolean) |
Gets a reference to a binary primitive type definition. |
| GetBoolean(Boolean) |
Gets a reference to the Boolean primitive type definition. |
| GetByte(Boolean) |
Gets a reference to the Byte primitive type definition. |
| GetCollection(IEdmTypeReference) |
Gets a reference to a non-atomic collection type definition. |
| GetComplexType() |
Gets Edm.ComplexType type. |
| GetComplexType(Boolean) |
Gets a reference to the Edm.ComplexType type definition. |
| GetDate(Boolean) |
Get a reference to the Date primitive type definition. |
| GetDateTimeOffset(Boolean) |
Gets a reference to a datetime with offset primitive type definition. |
| GetDecimal(Boolean) |
Gets a reference to a decimal primitive type definition. |
| GetDecimal(Nullable<Int32>, Nullable<Int32>, Boolean) |
Gets a reference to a decimal primitive type definition. |
| GetDouble(Boolean) |
Gets a reference to a double primitive type definition. |
| GetDuration(Boolean) |
Gets a reference to a duration primitive type definition. |
| GetEntityType() |
Gets Edm.EntityType type. |
| GetEntityType(Boolean) |
Gets a reference to the Edm.EntityType type definition. |
| GetGuid(Boolean) |
Gets a reference to the Guid primitive type definition. |
| GetInt16(Boolean) |
Gets a reference to the Int16 primitive type definition. |
| GetInt32(Boolean) |
Gets a reference to the Int32 primitive type definition. |
| GetInt64(Boolean) |
Gets a reference to the Int64 primitive type definition. |
| GetNavigationPropertyPath(Boolean) |
Gets a reference to the Edm.NavigationPropertyPath type definition. |
| GetPathType(EdmPathTypeKind) |
Gets path type by kind. |
| GetPathType(EdmPathTypeKind, Boolean) |
Gets a reference to a path type of the specified kind. |
| GetPathTypeKind(String) |
Gets the EdmPathTypeKind by the type name. |
| GetPrimitive(EdmPrimitiveTypeKind, Boolean) |
Gets a reference to a primitive type of the specified kind. |
| GetPrimitiveType() |
Gets Edm.PrimitiveType type. |
| GetPrimitiveType(Boolean) |
Gets a reference to the Edm.PrimitiveType type definition. |
| GetPrimitiveType(EdmPrimitiveTypeKind) |
Gets primitive type by kind. |
| GetPrimitiveTypeKind(String) |
Gets the EdmPrimitiveTypeKind by the type name. |
| GetPropertyPath(Boolean) |
Gets a reference to the Edm.PropertyPath type definition. |
| GetSByte(Boolean) |
Gets a reference to the SByte primitive type definition. |
| GetSingle(Boolean) |
Gets a reference to a single primitive type definition. |
| GetSpatial(EdmPrimitiveTypeKind, Boolean) |
Gets a reference to a spatial primitive type definition. |
| GetSpatial(EdmPrimitiveTypeKind, Nullable<Int32>, Boolean) |
Gets a reference to a spatial primitive type definition. |
| GetStream(Boolean) |
Gets a reference to a stream primitive type definition. |
| GetString(Boolean) |
Gets a reference to a binary string type definition. |
| GetString(Boolean, Nullable<Int32>, Nullable<Boolean>, Boolean) |
Gets a reference to a string primitive type definition. |
| GetTemporal(EdmPrimitiveTypeKind, Boolean) |
Gets a reference to a temporal primitive type definition. |
| GetTemporal(EdmPrimitiveTypeKind, Nullable<Int32>, Boolean) |
Gets a reference to a temporal primitive type definition. |
| GetTimeOfDay(Boolean) |
Gets a reference to a TimeOfDay primitive type definition |
| GetUntyped() |
Gets a reference to a Edm.Untyped type definition. |
| GetUntyped(Boolean) |
Gets a reference to a Edm.Untyped type definition |
| GetUntypedType() |
Gets Edm.Untyped type. |
Extension Methods
| TryWriteSchema(IEdmModel, Func<String,XmlWriter>, IEnumerable<EdmError>) |
Outputs Schema artifacts to the provided writers. |
| TryWriteSchema(IEdmModel, XmlWriter, IEnumerable<EdmError>) |
Outputs a Schema artifact to the provided writer. |
| GetEdmxVersion(IEdmModel) |
Gets the value for the EDMX version of the |
| GetNamespaceAlias(IEdmModel, String) |
Gets the serialization alias for a given namespace. |
| GetNamespacePrefixMappings(IEdmModel) |
Gets the preferred prefix mappings for xml namespaces from an IEdmModel |
| SetEdmxVersion(IEdmModel, Version) |
Sets a value of EDMX version attribute of the |
| SetNamespaceAlias(IEdmModel, String, String) |
Sets the serialization alias for a given namespace(including current model's schemas namespace-alias, and referenced models' schemas namespace-alias) TODO: REF make sure no duplicated alias. |
| SetNamespacePrefixMappings(IEdmModel, IEnumerable<KeyValuePair<String,String>>) |
Sets an annotation on the IEdmModel to notify the serializer of preferred prefix mappings for xml namespaces. |
| GetMimeType(IEdmModel, IEdmOperation) |
Checks whether the |
| GetMimeType(IEdmModel, IEdmProperty) |
Checks whether the |
| SetMimeType(IEdmModel, IEdmOperation, String) |
Sets the MIME type annotation of the |
| SetMimeType(IEdmModel, IEdmProperty, String) |
Sets the MIME type annotation of the |
| DirectValueAnnotations(IEdmModel, IEdmElement) |
Gets the direct annotations for an element. |
| ExistsContainer(IEdmModel, String) |
If the container name in the model is the same as the input name. The input name maybe full qualified name. |
| FindAllDerivedTypes(IEdmModel, IEdmStructuredType) |
Finds a list of types that derive from the supplied type directly or indirectly, and across models. |
| FindBoundOperations(IEdmModel, IEdmType) |
Searches for bound operations based on the binding type, returns an empty enumerable if no operation exists. |
| FindBoundOperations(IEdmModel, String, IEdmType) |
Searches for bound operations based on the qualified name and binding type, returns an empty enumerable if no operation exists. |
| FindDeclaredEntitySet(IEdmModel, String) |
Searches for entity set by the given name that may be container qualified in default container and .Extends containers. |
| FindDeclaredNavigationSource(IEdmModel, String) |
Searches for entity set or singleton by the given name that may be container qualified in default container and .Extends containers. If no container name is provided, then default container will be searched. |
| FindDeclaredOperationImports(IEdmModel, String) |
Searches for the operation imports by the specified name in default container and .Extends containers, returns an empty enumerable if no operation import exists. |
| FindDeclaredSingleton(IEdmModel, String) |
Searches for singleton by the given name that may be container qualified in default container and .Extends containers. If no container name is provided, then default container will be searched. |
| FindEntityContainer(IEdmModel, String) |
Searches for an entity container with the given name in this model and all referenced models and returns null if no such entity container exists. |
| FindOperations(IEdmModel, String) |
Searches for operations with the given name in this model and all referenced models and returns an empty enumerable if no such operations exist. |
| FindTerm(IEdmModel, String) |
Searches for a term with the given name in this model and all referenced models and returns null if no such term exists. |
| FindType(IEdmModel, String) |
Searches for a type with the given name in this model and all referenced models and returns null if no such type exists. |
| FindVocabularyAnnotations(IEdmModel, IEdmVocabularyAnnotatable) |
Gets an annotatable element's vocabulary annotations defined in a specific model and models referenced by that model. |
| FindVocabularyAnnotations<T>(IEdmModel, IEdmVocabularyAnnotatable, IEdmTerm) |
Gets an annotatable element's vocabulary annotations that bind a particular term. |
| FindVocabularyAnnotations<T>(IEdmModel, IEdmVocabularyAnnotatable, IEdmTerm, String) |
Gets an annotatable element's vocabulary annotations that bind a particular term. |
| FindVocabularyAnnotations<T>(IEdmModel, IEdmVocabularyAnnotatable, String) |
Gets an annotatable element's vocabulary annotations that bind a particular term. |
| FindVocabularyAnnotations<T>(IEdmModel, IEdmVocabularyAnnotatable, String, String) |
Gets an annotatable element's vocabulary annotations that bind a particular term. |
| FindVocabularyAnnotationsIncludingInheritedAnnotations(IEdmModel, IEdmVocabularyAnnotatable) |
Gets an annotatable element's vocabulary annotations defined in a specific model and models referenced by that model. |
| GetAlternateKeysAnnotation(IEdmModel, IEdmEntityType) |
Gets the declared alternate keys of the most defined entity with a declared key present. |
| GetAnnotationValue(IEdmModel, IEdmElement, String, String) |
Gets an annotation value corresponding to the given namespace and name provided. |
| GetAnnotationValue<T>(IEdmModel, IEdmElement) |
Gets an annotation value from an annotatable element. |
| GetAnnotationValue<T>(IEdmModel, IEdmElement, String, String) |
Gets an annotation value corresponding to the given namespace and name provided. |
| GetAnnotationValues(IEdmModel, IEnumerable<IEdmDirectValueAnnotationBinding>) |
Retrieves a set of annotation values. For each requested value, returns null if no annotation with the given name exists for the given element. |
| GetDerivedTypeConstraints(IEdmModel, IEdmNavigationSource) |
Gets the collection of qualified type name for term Org.OData.Validation.V1.DerivedTypeConstraint from a navigation source. |
| GetDerivedTypeConstraints(IEdmModel, IEdmVocabularyAnnotatable) |
Gets the collection of qualified type name for term Org.OData.Validation.V1.DerivedTypeConstraint from a target annotatable. |
| GetDescriptionAnnotation(IEdmModel, IEdmVocabularyAnnotatable) |
Gets description for term Org.OData.Core.V1.Description from a target annotatable |
| GetEdmReferences(IEdmModel) |
Gets edmx:Reference information (IEdmReference) from the model. |
| GetEdmVersion(IEdmModel) |
Gets the value for the EDM version of the |
| GetLongDescriptionAnnotation(IEdmModel, IEdmVocabularyAnnotatable) |
Gets description for term Org.OData.Core.V1.LongDescription from a target annotatable |
| GetPrimitiveValueConverter(IEdmModel, IEdmTypeReference) |
Get the primitive value converter for the given type definition in the model. |
| GetTermValue(IEdmModel, IEdmStructuredValue, IEdmTerm, EdmExpressionEvaluator) |
Gets the IEdmValue of a vocabulary term that has been applied to the type of a value. |
| GetTermValue(IEdmModel, IEdmStructuredValue, IEdmTerm, String, EdmExpressionEvaluator) |
Gets the IEdmValue of a vocabulary term that has been applied to the type of a value. |
| GetTermValue(IEdmModel, IEdmStructuredValue, String, EdmExpressionEvaluator) |
Gets the IEdmValue of a vocabulary term that has been applied to the type of a value. |
| GetTermValue(IEdmModel, IEdmStructuredValue, String, String, EdmExpressionEvaluator) |
Gets the IEdmValue of a vocabulary term that has been applied to the type of a value. |
| GetTermValue(IEdmModel, IEdmVocabularyAnnotatable, IEdmTerm, EdmExpressionEvaluator) |
Gets the IEdmValue of a vocabulary term that has been applied to an element. |
| GetTermValue(IEdmModel, IEdmVocabularyAnnotatable, IEdmTerm, String, EdmExpressionEvaluator) |
Gets the IEdmValue of a vocabulary term that has been applied to an element. |
| GetTermValue(IEdmModel, IEdmVocabularyAnnotatable, String, EdmExpressionEvaluator) |
Gets the IEdmValue of a vocabulary term that has been applied to an element. |
| GetTermValue(IEdmModel, IEdmVocabularyAnnotatable, String, String, EdmExpressionEvaluator) |
Gets the IEdmValue of a vocabulary term that has been applied to an element. |
| GetTermValue<T>(IEdmModel, IEdmStructuredValue, IEdmTerm, EdmToClrEvaluator) |
Gets the CLR value of a vocabulary term that has been applied to the type of a value. |
| GetTermValue<T>(IEdmModel, IEdmStructuredValue, IEdmTerm, String, EdmToClrEvaluator) |
Gets the CLR value of a vocabulary term that has been applied to the type of a value. |
| GetTermValue<T>(IEdmModel, IEdmStructuredValue, String, EdmToClrEvaluator) |
Gets the CLR value of a vocabulary term that has been applied to the type of a value. |
| GetTermValue<T>(IEdmModel, IEdmStructuredValue, String, String, EdmToClrEvaluator) |
Gets the CLR value of a vocabulary term that has been applied to the type of a value. |
| GetTermValue<T>(IEdmModel, IEdmVocabularyAnnotatable, IEdmTerm, EdmToClrEvaluator) |
Gets the CLR value of a vocabulary term that has been applied to an element. |
| GetTermValue<T>(IEdmModel, IEdmVocabularyAnnotatable, IEdmTerm, String, EdmToClrEvaluator) |
Gets the CLR value of a vocabulary term that has been applied to an element. |
| GetTermValue<T>(IEdmModel, IEdmVocabularyAnnotatable, String, EdmToClrEvaluator) |
Gets the CLR value of a vocabulary term that has been applied to an element. |
| GetTermValue<T>(IEdmModel, IEdmVocabularyAnnotatable, String, String, EdmToClrEvaluator) |
Gets the CLR value of a vocabulary term that has been applied to an element. |
| Location(IEdmElement) |
Gets the location of this element. |
| SchemaElementsAcrossModels(IEdmModel) |
Gets all schema elements from the model, and models referenced by it. |
| SetAnnotationValue(IEdmModel, IEdmElement, String, String, Object) |
Sets an annotation value for an EDM element. If the value is null, no annotation is added and an existing annotation with the same name is removed. |
| SetAnnotationValue<T>(IEdmModel, IEdmElement, T) |
Sets an annotation value on an annotatable element. |
| SetAnnotationValues(IEdmModel, IEnumerable<IEdmDirectValueAnnotationBinding>) |
Sets a set of annotation values. If a supplied value is null, no annotation is added and an existing annotation with the same name is removed. |
| SetEdmReferences(IEdmModel, IEnumerable<IEdmReference>) |
Sets edmx:Reference information (IEdmReference) to the model. |
| SetEdmVersion(IEdmModel, Version) |
Sets a value of EDM version attribute of the |
| SetPrimitiveValueConverter(IEdmModel, IEdmTypeDefinitionReference, IPrimitiveValueConverter) |
Set the primitive value converter for the given type definition in the model. |
| TryFindContainerQualifiedEntitySet(IEdmModel, String, IEdmEntitySet) |
Finds the entity set with qualified entity set name (not simple entity set name). |
| TryFindContainerQualifiedOperationImports(IEdmModel, String, IEnumerable<IEdmOperationImport>) |
Tries the find container qualified operation imports. |
| TryFindContainerQualifiedSingleton(IEdmModel, String, IEdmSingleton) |
Finds the singleton. |
| Validate(IEdmModel, ValidationRuleSet, IEnumerable<EdmError>) |
Validate the IEdmModel and all of its properties given certain version. |
| Validate(IEdmModel, IEnumerable<EdmError>) |
Validate the IEdmModel and all of its properties using the current version of the model. If the model has no version, EdmVersionDefault is used. |
| Validate(IEdmModel, Version, IEnumerable<EdmError>) |
Validate the IEdmModel and all of its properties given certain version. |
| Errors(IEdmElement) |
Gets the errors, if any, that belong to this element or elements that this element contains. For example errors for a structural type include the errors of the type itself and errors of its declared properties. The method does not analyze elements referenced by this element. For example errors of a property do not include errors from its type. |
| IsBad(IEdmElement) |
Returns true if this element contains errors returned by the Errors(IEdmElement) method. |
| GetVocabularyStringCollection(IEdmModel, IEdmVocabularyAnnotatable, IEdmTerm) |
Gets the collection of string for a target annotatable. |