IDataClass Interface

DataClass interface.

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0

Syntax

public interface IDataClass : IAdvancedDataContainer, 
	IDataContainer, ISimpleDataContainer

The IDataClass type exposes the following members.

Properties

	Name	Description
Public property	AllowPartialUpdate	If true, the object allows partial updates.
Public property	ClassName	Name of the data class
Public property	ColumnNames	Column names. (Inherited from IDataContainer.)
Public property	ColumnsCount	Number of the object columns.
Public property	HasChanged	Returns true if the object changed. (Inherited from IAdvancedDataContainer.)
Public property	ID	Object ID.
Public property	IDColumn	ID column(s).
Public property	IsComplete	Returns true if the object is complete (has all columns). (Inherited from IAdvancedDataContainer.)
Public property	IsReadOnly	Indicates whether class is in read-only mode.
Public property	Item	Gets or sets the value of the column. (Inherited from ISimpleDataContainer.)
Public property	StructureInfo	Class structure information.
Public property	UseOriginalData	If true, original data is used instead of the actual data.

Methods

	Name	Description
Public method	ChangedColumns	Returns list of column names which values were changed. (Inherited from IAdvancedDataContainer.)
Public method	ContainsColumn	Returns true if the object contains specified column. (Inherited from IDataContainer.)
Public method	CopyDataTo	Copies the class data to other data class
Public method	CopyOriginalDataTo	Copies the original class data to other data class
Public method	DataChanged	Returns true if the object changed. (Inherited from IAdvancedDataContainer.)
Public method	Delete	Deletes current record.
Public method	GetDataSet	Gets the DataSet from the object data.
Public method	GetOriginalValue	Returns the original value of column. (Inherited from IAdvancedDataContainer.)
Public method	GetValue	Returns value of column. (Inherited from ISimpleDataContainer.)
Public method	Init	Initializes an instance of data class after created by empty constructor
Public method	Insert	Inserts current record in the database.
Public method	IsEmpty	Returns true if the object is empty.
Public method	ItemChanged	Returns true if the item on specified column name changed. (Inherited from IAdvancedDataContainer.)
Public method	LoadData(Int32)	Loads the object data by the given primary key value
Public method	LoadData(IDataContainer, Boolean)	Loads the object data from given data container.
Public method	MakeComplete	Makes the object data complete. (Inherited from IAdvancedDataContainer.)
Public method	ResetChanges	Resets the object changes and keeps the new values as unchanged. (Inherited from IAdvancedDataContainer.)
Public method	RevertChanges	Reverts the object changes to the original values. (Inherited from IAdvancedDataContainer.)
Public method	SetReadOnly	Locks the data class as a read-only
Public method	SetValue	Sets value of column. (Inherited from ISimpleDataContainer.)
Public method	TryGetValue	Returns value of column. (Inherited from IDataContainer.)
Public method	Update	Updates current record.
Public method	Upsert	Updates or inserts the current record.

Extension Methods

	Name	Description
Public Extension Method	CheckRequiredColumns	Returns true if given list of columns do not have null values in the object (Defined by DataExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, Boolean)	Overloaded. Writes XML representation of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)
Public Extension Method	ToXML(String, Boolean)	Overloaded. Returns XML representation of current instance of IDataContainer. (Defined by DataExtensions.)
Public Extension Method	ToXML(XmlWriter, List<String>, Boolean)	Overloaded. Writes XML representation of selected columns of current instance of IDataContainer to provided XmlWriter. (Defined by DataExtensions.)