Click or drag to resize

IEntity Interface


Represents an object that has a unique ID and name; has a list of update information; and can be serialized to XML. Entities should only be manipulated within a UserWriteSession. Also, it should only have its methods and properties called within the UserSession where it was originally retrieved.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
Syntax
public interface IEntity : IEntityEvents

The IEntity type exposes the following members.

Properties
 NameDescription
Public propertyArchived Gets/sets the archived value of this entity
Public propertyCreated Gets the entity's creation date.
Public propertyCreationUser Gets the ID of the User who created this entity.
Public propertyLastModified Gets the date when the entity was most recently modified.
Public propertyLastModifiedUser Gets the ID of the User who lasted edited the entity.
Public propertySession Gets the session that retrieved this entity. An entity is always session-specific.
Public propertySessionId Gets the unique ID of the session that retrieved this entity.
Top
Methods
 NameDescription
Public methodTouch Updated the entity's LastModified value to the current time.
Public methodValidateData Validates this entity's data. Implemented by concrete inheriting types.
Public methodValidateUserPermission Validates the user permission on the current entity. Implemented by concrete inheriting types. It is called automatically upon saving an entity.
Top
Events
 NameDescription
Public eventAfterEntitySave This event is fired after a Entity object is saved.
(Inherited from IEntityEvents)
Public eventBeforeEntitySave This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents)
Top
See Also