Entity Class

Represents the base class of all entities (persons, places, things) in SanteDB

Inheritance Hierarchy

SystemObject
  SanteDB.Core.ModelIdentifiedData
    SanteDB.Core.ModelBaseEntityData
      SanteDB.Core.ModelVersionedEntityDataEntity
        SanteDB.Core.Model.EntitiesEntity
          More...

Namespace: SanteDB.Core.Model.Entities
Assembly: SanteDB.Core.Model (in SanteDB.Core.Model.dll) Version: 2.2.1

Syntax

C++

Copy

public class Entity : VersionedEntityData<Entity>, 
	ITaggable, IExtendable, IIdentifiedEntity, ISecurable, IHasClassConcept, 
	IHasTypeConcept, IHasState, IHasTemplate, IHasIdentifiers, IHasRelationships

Public Class Entity
	Inherits VersionedEntityData(Of Entity)
	Implements ITaggable, IExtendable, IIdentifiedEntity, ISecurable, 
	IHasClassConcept, IHasTypeConcept, IHasState, IHasTemplate, IHasIdentifiers, 
	IHasRelationships

public ref class Entity : public VersionedEntityData<Entity^>, 
	ITaggable, IExtendable, IIdentifiedEntity, ISecurable, IHasClassConcept, 
	IHasTypeConcept, IHasState, IHasTemplate, IHasIdentifiers, IHasRelationships

type Entity =  
    class
        inherit VersionedEntityData<Entity>
        interface ITaggable
        interface IExtendable
        interface IIdentifiedEntity
        interface ISecurable
        interface IHasClassConcept
        interface IHasTypeConcept
        interface IHasState
        interface IHasTemplate
        interface IHasIdentifiers
        interface IHasRelationships
    end

The Entity type exposes the following members.

Constructors

	Name	Description
	Entity	Creates a new instance of the entity class

Top

Properties

	Name	Description
	Addresses	Gets a list of all addresses associated with the entity
	BatchOperation	Gets or sets the operation (Inherited from IdentifiedData.)
	ClassConcept	Class concept datal load property
	ClassConceptKey	Class concept
	CreatedBy	Gets or sets the user that created this base data (Inherited from BaseEntityData.)
	CreatedByKey	Gets or sets the security provenance object which represents the creation of this object (Inherited from BaseEntityData.)
	CreationAct	Creation act reference
	CreationActKey	Creation act reference
	CreationTime	Gets or sets the time at which the data was created (Inherited from BaseEntityData.)
	CreationTimeXml	Gets or sets the creation time as an ISO date format (Inherited from BaseEntityData.)
	DeterminerConcept	Determiner concept
	DeterminerConceptKey	Determiner concept
	Extensions	Gets a list of all extensions associated with the entity
	Identifiers	Gets the identifiers associated with this entity
	IsDelayLoadEnabled	True if the class is currently loading associations when accessed (Inherited from IdentifiedData.)
	Key	Gets or sets the primary identifying UUID of this object (Inherited from IdentifiedData.)
	LoadState	Gets or sets whether the object was partial loaded (Inherited from IdentifiedData.)
	ModifiedOn	Gets the time that the object was last modified (from base data, default to CreationTime) (Inherited from BaseEntityData.)
	Names	Gets a list of all names associated with the entity
	Notes	Gets a list of all notes associated with the entity
	ObsoletedBy	Gets or sets the user that obsoleted this base data (Inherited from BaseEntityData.)
	ObsoletedByKey	Gets or sets the security provenance object which represents the obsoletion of this data (Inherited from BaseEntityData.)
	ObsoletionTime	Gets or sets the time when the data is or will become invalid (Inherited from BaseEntityData.)
	ObsoletionTimeXml	Gets or sets the time that the data is no longer valid (was deleted/obsoleted) in ISO format (Inherited from BaseEntityData.)
	Participations	Gets the acts in which this entity participates
	Policies	Gets or sets the security policy instances associated with the entity
	PreviousVersionKey	Gets or sets the UUID of the previous version of this record (Inherited from VersionedEntityDataTHistoryModelType.)
	Relationships	Gets a list of all associated entities for this entity
	StatusConcept	Status concept id
	StatusConceptKey	Status concept id
	Tag	Override the ETag (Inherited from VersionedEntityDataTHistoryModelType.)
	Tags	Gets a list of all tags associated with the entity
	Telecoms	Gets a list of all telecommunications addresses associated with the entity
	Template	Gets or sets the template definition
	TemplateKey	Gets the template key
	Type	Gets the type registration of this object (Inherited from IdentifiedData.)
	TypeConcept	Type concept identifier
	TypeConceptKey	Type concept identifier
	VersionKey	Gets or sets the UUID of the current version of this object (Inherited from VersionedEntityDataTHistoryModelType.)
	VersionSequence	The sequence number of the version (for ordering) (Inherited from VersionedEntityDataTHistoryModelType.)

Top

Methods

	Name	Description
	AddAnnotation	Add an annotated object (Inherited from IdentifiedData.)
	AddExtension	Add an extension to this entity
	AddPolicy	Add a policy to this entity
	AddTag	Add a tag to this entity
	Clone	Clone this object (Inherited from IdentifiedData.)
	Copy	Copies the entity
	CopyAnnotations	Copy annotations from another resource (Inherited from IdentifiedData.)
	DeepCopy	Provide a deep copy of the specified data (Inherited from IdentifiedData.)
	DelayLoadTEntity	Get associated entity (Inherited from IdentifiedData.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAnnotationsT	Get annotations of specified T (Inherited from IdentifiedData.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetLocked	Clone the specified data (Inherited from IdentifiedData.)
	GetPreviousVersion	Gets the previous version or loads it from the database if needed (Inherited from VersionedEntityDataTHistoryModelType.)
	GetTag	Get the specified tag
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasPolicy	Detects whether this object has a policy
	IsEmpty	Determines w (Inherited from IdentifiedData.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	RemoveAllTags	Remove tags matching predicate from the tag collection
	RemoveAnnotation	Remove annotation (Inherited from IdentifiedData.)
	RemoveExtension	Remove the specified extension
	RemoveTag	Remove the specified tagKey from this objects tags
	SemanticEquals	Semantic equality function (Overrides IdentifiedDataSemanticEquals(Object).)
	SetPreviousVersion	Sets the previous version (Inherited from VersionedEntityDataTHistoryModelType.)
	ShouldSerializeAddresses	Should serialize addresses
	ShouldSerializeBatchOperation	Should serialize batch operation (Inherited from IdentifiedData.)
	ShouldSerializeCreatedByKey	True if key should be serialized (Inherited from BaseEntityData.)
	ShouldSerializeCreationActKey	Should serialize creation act
	ShouldSerializeExtensions	Shoudl serialize extensions
	ShouldSerializeIdentifiers	Should serialize identifiers
	ShouldSerializeKey	True if key should be serialized (Inherited from IdentifiedData.)
	ShouldSerializeModifiedOn	Never serialize modified on (Inherited from IdentifiedData.)
	ShouldSerializeNames	Should serialize Names
	ShouldSerializeNotes	Should serialize notes
	ShouldSerializeObsoletedByKey	True if key should be serialized (Inherited from BaseEntityData.)
	ShouldSerializeParticipations	Should serialize participations
	ShouldSerializePreviousVersionKey	Should serialize previous version? (Inherited from VersionedEntityDataTHistoryModelType.)
	ShouldSerializeTags	Should serialize tags
	ShouldSerializeTelecoms	Should serialize telecoms
	ShouldSerializeTemplateKey	Should serialize template key
	ShouldSerializeTypeConceptKey	Should serialize type concept
	ToDisplay	Render the display of this entity (Overrides IdentifiedDataToDisplay.)
	ToString	Represent the versioned data as a string (Inherited from VersionedEntityDataTHistoryModelType.)
	TryGetTag	Try to fetch the tag

Top

Fields

	Name	Description
	m_annotations	A list of custom tags which were added to this object (Inherited from IdentifiedData.)

Top

Extension Methods

	Name	Description
	ConvertTReturn	The purpose of this method is to convert object me to TReturn. Why? Because if you have an instance of Act that actually needs to be a SubstanceAdministration we can't just cast so we have to copy. (Defined by ExtensionMethods.)
	CreateExtensions	Runs all registered extensions on the object (Defined by ExtensionUtil.)
	GetAddresses	Gets or loads addresses attached to an entity (Defined by DelayLoadUtils.)
	GetExtensions	Gets or loads extensions (Defined by DelayLoadUtils.)
	GetIdentifiers	Gets or loads identifiers (Defined by DelayLoadUtils.)
	GetInstanceOfTDomain	Gets an instance of TDomain from me (Defined by ModelExtensions.)
	GetNames	Gets or loads names attached to an entity (Defined by DelayLoadUtils.)
	GetNotes	Gets or loads notes (Defined by DelayLoadUtils.)
	GetRelationships	Gets or loads relationships (Defined by DelayLoadUtils.)
	GetTags	Gets or loads tags (Defined by DelayLoadUtils.)
	GetTelecoms	Gets or loads telecoms attached to an entity (Defined by DelayLoadUtils.)
	LoadCollectionTReturn	Delay load property (Defined by ExtensionMethods.)
	LoadProperty(String, Boolean)	Overloaded. Delay load property (Defined by ExtensionMethods.)
	LoadPropertyTReturn(String, Boolean)	Overloaded. Delay load property (Defined by ExtensionMethods.)
	TryGetExisting	Try get by classifier (Defined by ModelExtensions.)
	UpdateParentKeys	(Defined by ModelExtensions.)
	WasLoaded	Returns true if the property has been loaded (Defined by ExtensionMethods.)

Top

Remarks

In SanteDB, an entity represents a physical object which can be acted upon or can participate in an act.

Reference

SanteDB.Core.Model.Entities Namespace

Inheritance Hierarchy