BaseInfo.GeneralizedInfoWrapper Class

Info object wrapper for generalized access

Inheritance Hierarchy

System.Object
  CMS.DataEngine.BaseInfo.GeneralizedInfoWrapper
    CMS.DataEngine.GeneralizedInfo

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

Syntax

public abstract class GeneralizedInfoWrapper : ICMSObject, 
	IHierarchicalDataContainer, IDataContainer, ISimpleDataContainer, IHierarchicalObject, INameIndexable, 
	IVirtualHierarchicalObject, ICMSStorage, IRelatedData

The BaseInfo.GeneralizedInfoWrapper type exposes the following members.

Constructors

	Name	Description
Protected method	BaseInfo.GeneralizedInfoWrapper	Constructor

Properties

	Name	Description
Public property	AllowClone	Indicates if the object supports cloning.
Public property	AllowRestore	Indicates if the object supports deleting to recycle bin.
Public property	AllowTouchParent	Indicates if parent is allowed to be touched, if exists.
Public property	Bindings	The collection of the binding objects for the given object.
Public property	CacheParentData	If true, the parent object data is cached within object.
Public property	CheckUnique	If true, the code name is checked for uniqueness upon saving.
Public property	ChildDependencies	Collection of the child dependencies for the given object.
Public property	Children	The collection of the child objects for the given object.
Public property	CodeNameColumn	Code name column name of the info record.
Public property	ColumnNames	Column names.
Public property	CustomizedColumns	Gets the list of customized columns in current object
Public property	DisplayNameColumn	Code name column name of the info record.
Public property	HasChanged	Returns true if the object has changed.
Public property	HasData	Returns true if the object has it's data storage initialized already
Public property	IgnoreExternalColumns	If true, externally stored columns are ignored and are stored normally in DB.
Public property	IsCachedObject	If true, the object is cached within the system for later use
Public property	IsCheckedOut	Indicates if the object is checked out.
Public property	IsCheckedOutByUserID	Gets ID of the user who checked the object out.
Public property	IsClone	Indicates if the object is clone.
Public property	IsComplete	Returns true if the object is complete (has all columns).
Public property	IsDisconnected	Returns true if the object is disconnected from the data source
Public property	IsObjectValid	Returns true if the object is considered valid.
Public property	Item	Gets or sets the value of the column.
Public property	LogEvents	If true, events are logged on the object update.
Public property	LogExport	If true, export tasks are logged on the object update.
Public property	LogIntegration	If true, integration tasks are being logged.
Public property	LogSynchronization	If true, synchronization tasks are logged on the object update.
Public property	LogWebFarmTasks	If true, web farm tasks are logged on the object update.
Public property	MainObject	Main object for this general access object
Public property	MetaFiles	The collection of the metafiles of the given object.
Public property	ObjectCategory	Object category.
Public property	ObjectCodeName	Object code name.
Public property	ObjectDisplayName	Object name.
Public property	ObjectFullName	Object full name if exists
Public property	ObjectGroupID	Object group ID.
Public property	ObjectGUID	Object GUID.
Public property	ObjectIcon	Object icon
Public property	ObjectIconGUID	Object icon GUID.
Public property	ObjectID	Object ID.
Public property	ObjectIsCustom	Indicates if object is custom (created by customer).
Public property	ObjectIsCustomized	Indicates if object is customized.
Public property	ObjectLastModified	Object last modified time.
Public property	ObjectOrder	Returns the order of the object among the other objects.
Public property	ObjectParent	Object parent
Public property	ObjectParentID	Object parent ID.
Public property	ObjectSiteID	Object site ID.
Public property	ObjectSiteName	Object site name.
Public property	ObjectThumbnail	Object thumbnail
Public property	ObjectThumbnailGUID	Object thumbnail GUID.
Public property	ObjectVersionGUID	Object version GUID.
Public property	OriginalObjectCodeName	Returns the original object code name
Public property	OtherBindings	The collection of the other binding objects for the given object.
Public property	ParentObjectType	Parent object type.
Public property	PrioritizedProperties	Gets the list of properties which should be prioritized in the macro controls (IntelliSense, MacroTree).
Public property	Processes	The collection of the processes of the given object.
Public property	Properties	Properties of the object available through GetProperty.
Public property	ReferringObjects	Collection of the objects depending on this object (object which have FK to this object).
Public property	RelatedData	Custom data connected to the object.
Public property	ScheduledTasks	The collection of the scheduled tasks of the given object.
Public property	SupportsVersioning	Indicates if the object versioning is supported.
Public property	TouchCacheDependencies	If true, cache dependencies are touched when the object is changed.
Public property	TypeInfo	Type info.
Public property	UpdateTimeStamp	If true, time stamp is updated on object update.
Public property	ValidateCodeName	If true, the code name is validated upon saving.
Public property	VersioningEnabled	Indicates if the object versioning is enabled by the settings.

Methods

	Name	Description
Public method	AnyItemChanged	Returns true if any of the specified column names has changed.
Public method	CheckDependencies	Checks object for dependent objects. Returns true if there is at least one dependent object. First tries to execute checkdependencies query, if not found, an automatic process is executed.
Public method	CheckLicense	Checks the object license. Returns true if the licensing conditions for this object were matched
Public method	CheckPermissions	Checks whether the specified user has permissions for this object.
Public method	CheckUniqueCodeName	Checks if the object has unique code name. Returns true if the object has unique code name.
Public method	CheckUniqueValues	Checks if a record with the same column values already exists in the database. Returns true if the set of values is unique.
Public method	Clone	Returns the clone
Public method	ContainsColumn	Returns true if the object contains specified column.
Public method	DataChanged()	Returns true if the object changed.
Public method	DataChanged(String)	Returns true if the object changed.
Public method	DeleteData	Deletes the object from the database.
Public method	DeleteExternalColumns	Goes through the columns which are stored externally and deletes all the files.
Public method	DeleteObject	Deletes the object using appropriate provider.
Public method	Disconnect	Disconnects the object from database.
Public method	EnsureBinaryData()	Makes sure that the binary data is loaded into binary column of the object when StoreToFileSystem is true.
Public method	EnsureBinaryData(Boolean)	Makes sure that the binary data is loaded into binary column of the object.
Public method	EnsureCodeName	Ensures the code name of the object if not set
Public method	EnsureGUID	Ensures the GUID of the object
Public method	EnsureUniqueCodeName	Ensures that the object has a unique code name within it's context
Public method	ExportDefaultData	Exports the default object installation data
Public method	GetBinaryData	Returns the BinaryData object of the current instance. Has to be overridden by specific classes. Returns null by default.
Public method	GetCacheDependencies	Gets collection of dependency keys to be touched when modifying the current object.
Public method	GetChildWhereCondition	Gets the child object where condition.
Public method	GetColumnType	Gets the column type.
Public method	GetCount	Gets count of the objects filtered by given where condition.
Public method	GetData	Returns the data according to the set of input parameters.
Public method	GetDataQuery	Gets the data query for this object type
Public method	GetDefaultDataWhereCondition	Gets where condition for default data according to TypeInfo configuration.
Public method	GetDefaultObject	Returns default object of given object type. Returns null by default. Example is UserInfo which returns user specified in the settings or Global Administrator.
Public method	GetDependenciesNames	Returns a list of object names which depend on this object. First tries to execute checkdependencies query, if not found, an automatic process is executed.
Public method	GetDependencyObjectType	Gets dependency object type
Public method	GetExisting	Returns the existing object based on current object data.
Public method	GetExternalColumns	Returns the list of columns registered as the external columns.
Public method	GetExternalFiles	Goes through the columns which are stored externally and returns the list of particular files this object uses.
Public method	GetFullObjectName	Returns the name of the object within its parent hierarchy.
Public method	GetIconUrl	Gets the object icon URL
Public method	GetLastObjectOrder	Returns number which will be the last order within all the other items (according to Parent, Group and Site settings).
Public method	GetLockObject	Gets the global lock object for all the instances of the object (locked on "objectType_objectId").
Public method	GetModifiedFrom	Gets the DataSet of all the objects modified from specified date.
Public method	GetObject(Int32)	Gets the object by its ID.
Public method	GetObject(String)	Gets the object by specified where condition.
Public method	GetObject(IWhereCondition)	Gets the object by specified where condition.
Public method	GetObjectKey	Gets the unique string key for the object.
Public method	GetOriginalValue	Returns the original value of column.
Public method	GetParent	Returns the parent object.
Public method	GetPhysicalFiles	Gets DataSet with physical files for current object.
Public method	GetProperty	Returns property with given name (either object or property value).
Public method	GetPropertyType	Gets the type of the given property
Public method	GetSynchronizedColumns	Gets the list of synchronized columns for this object.
Public method	GetThumbnailUrl	Gets the object thumbnail URL
Public method	GetUniqueCodeName	Returns the unique code name generated from current object code name.
Public method	GetUniqueDisplayName	Returns the unique display name generated from current object display name.
Public method	GetUniqueName	Returns the unique code name for the specified object, does not check duplicity if duplicity occurs within the currentObjectId.
Public method	GetValue	Returns value of column.
Public method	GetValueForTranslation	Returns value for translation services. Returns unmodified field content by default.
Public method	GetVirtualFileRelativePath	Returns virtual relative path for specific column
Public method	InitObjectsOrder	Initializes the proper order of the sibling objects so the order column is consistent.
Public method	InsertAsClone(CloneSettings)	Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original.
Public method	InsertAsClone(CloneSettings, CloneResult)	Inserts the object as a new object to the DB with inner data and structure (according to given settings) cloned from the original.
Public method	InsertData	Inserts the object to the database.
Public method	Invalidate	Invalidates the object in the object table.
Public method	IsAvailableOnSite	Checks whether info object as available on given site. Available means that object is global or assigned to given site.
Public method	IsCheckedOutByUser	Returns true if the object is checked out by the specified user.
Public method	IsChildOf	Returns true if the object is child of the given object. If parameter parent is null, returns true only if the object is not a child of any object.
Public method	IsModifiedExternally	Goes through the columns which are stored externally and checks if the data in DB is the same as in external storage. If all the columns are same returns true, otherwise false.
Public method	ItemChanged	Returns true if the item on specified column name changed.
Public method	MakeComplete	Makes the object data complete.
Public method	MoveObjectDown	Moves the object down within the object order (if OrderColumn is specified). The move is done within the object's parent and site (if defined).
Public method	MoveObjectUp	Moves the object up within the object order (if OrderColumn is specified). The move is done within the object's parent and site (if defined).
Public method	NewObject	Creates new object of the given class
Protected method	NotSupported	Throws the not supported exception
Public method	Reconnect	Reconnects the object to database.
Public method	ResetChanges	Resets the object changes and keeps the new values as unchanged.
Public method	RestoreSettings	Restores local settings for object instance.
Public method	RevertChanges	Reverts the object changes to the original values.
Public method	SaveExternalColumns	Goes through the columns which are stored externally and ensures them in the external storage.
Public method	SetObject	Updates the object using appropriate provider.
Public method	SetObjectAlphabeticalOrder	Moves the object to the right position according to the custom order.
Public method	SetObjectOrder	Moves the object to the specified order (if OrderColumn is specified). The move is done within the object's parent and site (if defined).
Public method	SetValue	Sets value of column.
Public method	SortAlphabetically	Moves the object to the right position according to the custom order.
Public method	StoreSettings	Stores local settings for object instance.
Public method	SubmitChanges	Submits the changes in the object to the database.
Public method	TouchParent	Updates the parent object by saving it (to update the timestamp).
Public method	TryGetProperty(String, Object)	Returns property with given name (either object or property value).
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property.
Public method	TryGetValue	Returns value of column.
Public method	UpdateData	Updates the object to the database.
Public method	UpdateExternalColumns	Goes through the columns which are stored externally and updates DB versions with the data from external storage.
Public method	UpdateFromDB	Updates the data of the object from DB (updates also ObjectSettings).
Public method	UpdatePathColumn	Updates given path column.
Public method	UpdatePhysicalFiles	Updates physical files in given DataSet for current object.

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.)