Entity Members

Include Protected Members
Include Inherited Members

Represents an entity such as Customer or Product, in a line-of-business (LOB) application.

The Entity type exposes the following members.

Properties

  Name Description
Public property EstimatedInstanceCount Gets the estimated number of entity instances of this entity.
Public property Id Gets the unique ID of each metadata object. (Inherited from MetadataObject.)
Public property IsCached Determines whether the metadata object is cached or not. (Inherited from MetadataObject.)
Public property Name Gets the name of the metadata object. (Inherited from MetadataObject.)

Top

Methods

  Name Description
Protected method ApplySystemLevelFilters (Inherited from DataClass.)
Public method CheckAccess Gets the rights the current user has on one or more entity instances.
Public method ContainsDefaultAction Determines whether the entity contains a default action.
Public method ContainsLocalizedDisplayName Determines whether the metadata object contains a localized display name. (Inherited from MetadataObject.)
Public method Equals (Inherited from Object.)
Public method Execute(MethodInstance, LobSystemInstance) Executes a method instance on the business application. (Inherited from DataClass.)
Public method Execute(MethodInstance, LobSystemInstance, []) Executes a MethodInstance on the business application. (Overrides DataClass.Execute(MethodInstance, LobSystemInstance, []).)
Protected method ExtractTargetAndTouchOuterStreams Infrastructure.
Protected method Finalize (Inherited from Object.)
Public method FindAssociated(EntityInstanceCollection, LobSystemInstance) Gets the entity instances associated with a given entity instance collection.
Public method FindAssociated(EntityInstanceCollection, Association, LobSystemInstance) Gets the entity instances associated with a given entity instance collection.
Public method FindAssociated(EntityInstanceCollection, FilterCollection, LobSystemInstance) Gets filtered entity instances associated with a given entity instance collection.
Public method FindAssociated(EntityInstanceCollection, Association, FilterCollection, LobSystemInstance) Gets the entity instances associated with a given entity instance collection.
Public method FindFiltered Gets a filtered set of entity instances from the business application.
Public method FindSpecific(Object, LobSystemInstance) Gets a single entity instance given its ID.
Public method FindSpecific([], LobSystemInstance) Gets a single entity instance given its ID.
Public method GetAccessCheckerMethodInstance Gets the AccessChecker MethodInstance for this entity.
Public method GetActions Gets the actions that the entity contains.
Public method GetAssociationView Gets the view of the specified association. It represents the fields that would be present in the entity instances returned if the association was executed.
Public methodStatic member GetById Gets an entity given its ID.
Public method GetDefaultAction Gets the default action associated with the entity.
Public method GetDefaultDisplayName Gets the default display name of the metadata object. (Inherited from MetadataObject.)
Public method GetDestinationAssociations Gets the associations where this entity is the destination in the relationship.
Public method GetFinderFilters Gets a collection of Finder filters defined for the entity.
Public method GetFinderMethodInstance Gets the method instance that defines the Finder method.
Public method GetFinderView Gets the view of the finder method. It represents the fields that would be present in the entity instances returned if the Finder was executed.
Public method GetHashCode (Inherited from Object.)
Public method GetIdentifierCount Gets the count of identifiers defined for the entity.
Public method GetIdentifiers Gets the identifiers defined for the entity.
Public method GetLobSystem Gets the LobSystem object this DataClass object (entity) belongs to. (Inherited from DataClass.)
Public method GetLocalizedDisplayName Gets the localized display name of the metadata object. (Inherited from MetadataObject.)
Public method GetMethodInstances Gets the method instances available for this DataClass object (entity). (Inherited from DataClass.)
Public method GetMethods Gets the methods available for this DataClass object (entity). (Inherited from DataClass.)
Public method GetProperties Gets the properties associated with the metadata object. (Inherited from MetadataObject.)
Public method GetSourceAssociations Gets the associations where this entity is the source entity in the relationship.
Public method GetSpecificFinderMethodInstance Gets the SpecificFinder method instance for this entity.
Public method GetSpecificFinderView Gets the view of the SpecificFinder method. It represents the fields that would be present in the entity instances returned if the SpecificFinder was executed.
Public method GetType (Inherited from Object.)
Public method GetViewAccessorMethodInstances Gets all method instances that are of MethodInstance type ViewAccessor for this entity.
Public method GetViewDefinition Gets the list of fields in a given view of an entity.
Public method HasAccessChecker Returns a true or false depending on whether this entity has an AccessChecker MethodInstance defined for it.
Public method HasFinder Indicates whether the entity has a Finder method defined.
Public method HasSpecificFinder Indicates whether the entity has a SpecificFinder method defined.
Protected method Initialize Initializes an Entity object.
Protected method MemberwiseClone (Inherited from Object.)
Public method ToString (Inherited from Object.)
Protected method WrapAsEntities Infrastructure.
Protected method WrapAsForeignKeyAssociation Infrastructure.

Top

Fields

  Name Description
Public fieldStatic member AuditSuppressPropertyName
Public fieldStatic member CanonicalNamePropertyName
Public fieldStatic member DefaultActionPropertyName Name of the Action to be used as the hyperlink in business data search results, business data columns, and elsewhere.
Public fieldStatic member DisplaySearchResultRightsMaskPropertyName Represents the rights mask that is used to convert a rights vector into a Yes or a No value.

Top

See Also

Reference

Entity Class

Microsoft.Office.Server.ApplicationRegistry.MetadataModel Namespace