Share via


IEdmEntityType Interface

Definition

Represents a definition of an EDM entity type.

public interface IEdmEntityType : Microsoft.OData.Edm.IEdmSchemaType, Microsoft.OData.Edm.IEdmStructuredType
type IEdmEntityType = interface
    interface IEdmStructuredType
    interface IEdmType
    interface IEdmElement
    interface IEdmSchemaType
    interface IEdmSchemaElement
    interface IEdmNamedElement
    interface IEdmVocabularyAnnotatable
Public Interface IEdmEntityType
Implements IEdmSchemaType, IEdmStructuredType
Derived
Implements

Properties

BaseType

Gets the base type of this type.

(Inherited from IEdmStructuredType)
DeclaredKey

Gets the structural properties of the entity type that make up the entity key.

DeclaredProperties

Gets the properties declared immediately within this type.

(Inherited from IEdmStructuredType)
HasStream

Gets the value indicating whether or not this type is a media entity.

IsAbstract

Gets a value indicating whether this type is abstract.

(Inherited from IEdmStructuredType)
IsOpen

Gets a value indicating whether this type is open.

(Inherited from IEdmStructuredType)
Name

Gets the name of this element.

(Inherited from IEdmNamedElement)
Namespace

Gets the namespace this schema element belongs to.

(Inherited from IEdmSchemaElement)
SchemaElementKind

Gets the kind of this schema element.

(Inherited from IEdmSchemaElement)
TypeKind

Gets the kind of this type.

(Inherited from IEdmType)

Methods

FindProperty(String)

Searches for a structural or navigation property with the given name in this type and all base types and returns null if no such property exists.

(Inherited from IEdmStructuredType)

Extension Methods

IsEquivalentTo(IEdmType, IEdmType)

Returns true if the compared type is semantically equivalent to this type. Schema types (IEdmSchemaType) are compared by their object refs.

AsActualType(IEdmType)

Returns the actual type of the given type. If the given type is type definition, the actual type is its underlying type; otherwise, return the given type itself.

InheritsFrom(IEdmStructuredType, IEdmStructuredType)

Determines if the potential base type is in the inheritance hierarchy of the type being tested.

IsBinary(IEdmType)

Returns true if this definition refers to a binary type.

IsDecimal(IEdmType)

Returns true if this definition refers to a decimal type.

IsGeography(IEdmType)

Returns true if this definition refers to a geography type.

IsGeometry(IEdmType)

Returns true if this definition refers to a geometry type.

IsOnSameTypeHierarchyLineWith(IEdmType, IEdmType)

Determines whether thisType is the same as otherType, or thisType derives from otherType, or otherType derives from thisType.

IsOrInheritsFrom(IEdmType, IEdmType)

Determines if a type is equivalent to or derived from another type.

IsSpatial(IEdmType)

Returns true if this definition refers to a spatial type.

IsStream(IEdmType)

Returns true if this reference refers to a stream type.

IsString(IEdmType)

Returns true if this definition refers to a string type.

IsTemporal(IEdmType)

Returns true if this definition refers to a temporal type.

IsUntyped(IEdmType)

Returns true if this definition refers to an untyped type.

GetSymbolicString(IEdmVocabularyAnnotatable)

Gets the symbolic string of an annotated element. In the next breaking change, it's better to add a property into IEdmVocabularyAnnotatable.

AsElementType(IEdmType)

Gets the element type of a collection definition or itself of a non-collection definition referred to by the type reference.

BaseEntityType(IEdmEntityType)

Gets the base type of this entity type definition.

BaseType(IEdmStructuredType)

Gets the base type of this structured type definition.

DeclaredNavigationProperties(IEdmStructuredType)

Gets the navigation properties declared in this structured type definition.

DeclaredStructuralProperties(IEdmStructuredType)

Gets all structural properties declared in the IEdmStructuredTypeDefinition.

FullName(IEdmSchemaElement)

Gets the full name of the element.

FullTypeName(IEdmType)

Gets the full name of the definition referred to by the type reference.

HasDeclaredKeyProperty(IEdmEntityType, IEdmProperty)

Checks whether the given entity type has the property as one of the key properties.

IsOpen(IEdmType)

Returns true if the definition of this reference is open.

Key(IEdmEntityType)

Gets the declared key of the most defined entity with a declared key present.

Location(IEdmElement)

Gets the location of this element.

NavigationProperties(IEdmStructuredType)

Get the navigation properties declared in this structured type and all base types.

Properties(IEdmStructuredType)

Gets all properties of the structured type definition and its base types.

ShortQualifiedName(IEdmSchemaElement)

Gets the Short Qualified name of the element.

StructuralProperties(IEdmStructuredType)

Gets the structural properties declared in this type definition and all base types.

VocabularyAnnotations(IEdmVocabularyAnnotatable, IEdmModel)

Gets an annotatable element's vocabulary annotations as seen from a particular model.

ToTraceString(IEdmSchemaElement)

Returns the text representation of the current object.

ToTraceString(IEdmSchemaType)

Returns the text representation of the current object.

ToTraceString(IEdmType)

Returns the text representation of the current object.

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.

Applies to