ObjectVersionManager Class

Class providing object versions management.

Inheritance Hierarchy

System.Object
  CMS.DataEngine.AbstractProvider
    CMS.DataEngine.AbstractProvider<ObjectVersionManager>
      CMS.Synchronization.ObjectVersionManager

Namespace: CMS.Synchronization
Assembly: CMS.Synchronization (in CMS.Synchronization.dll) Version: 8.2.23

Syntax

public class ObjectVersionManager : AbstractProvider<ObjectVersionManager>

The ObjectVersionManager type exposes the following members.

Constructors

	Name	Description
Public method	ObjectVersionManager

Methods

	Name	Description
Public method Static member	AllowObjectRestore(GeneralizedInfo)	Indicates if the object under specified site can be restored from recycle bin.
Public method Static member	AllowObjectRestore(GeneralizedInfo, String)	Obsolete. Indicates if the object under specified site can be restored from recycle bin.
Public method Static member	AllowObjectVersioning(GeneralizedInfo)	Indicates if the object versioning is allowed for specified object under particular site.
Public method Static member	AllowObjectVersioning(GeneralizedInfo, String)	Obsolete. Indicates if the object versioning is allowed for specified object under particular site.
Protected method	ClearHashtables(Boolean)	Clears the object's hashtables. (Inherited from AbstractProvider.)
Public method Static member	CreateVersion(GeneralizedInfo)	Creates object version.
Public method Static member	CreateVersion(GeneralizedInfo, Boolean)	Creates object version.
Public method	CreateWebFarmTask(String, String)	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Public method	CreateWebFarmTask(String, String, Byte[])	Creates web farm task specific for current object and action name (Inherited from AbstractProvider.)
Public method Static member	DeleteOlderVersions	Deletes older object versions.
Protected method	DeleteOlderVersionsInternal	Deletes older object versions.
Public method Static member	DestroyObjectHistory	Destroys complete object history.
Public method Static member	DestroyObjectVersion	Destroys object version.
Public method Static member	DisplayVersionsTab	Indicates if versions tab should be displayed for specified object type
Public method Static member	EnsureVersion	Ensures object version.
Public method Static member	GetLatestVersion	Gets latest version history for given object.
Protected method	GetLatestVersionInternal	Gets latest version history for given object.
Public method Static member	GetMajorVersionHistoryLength	Gets object major version history length.
Public method Static member	GetMinorVersionHistoryLength	Gets object version history length.
Public method Static member	GetNewVersionNumber	Gets new version number according to previous version number.
Protected method	GetNewVersionNumberInternal	Gets new version number according to previous version number.
Public method Static member	GetObjectHistory(String, Int32)	Gets object version histories.
Public method Static member	GetObjectHistory(String, Int32, String, String, Int32, String)	Gets object version histories.
Protected method	GetObjectHistoryInternal	Gets object version histories.
Public method Static member	GetObjectVersionedExtensions	Returns allowed extensions list from settings.
Public method Static member	GetPromoteToMajorInterval	Gets time interval between 2 modifications of object for which last version will be promoted to major version
Public method Static member	GetUseLastVersionInterval	Gets time interval for which last version will be used to store version data
Protected method	ChangePreviousVersionsObjectIDInternal	Changes object ID for the previous object versions during object restore.
Public method	CheckIn(BaseInfo)	Checks in the object.
Public method	CheckIn(BaseInfo, String, String)	Checks in the object.
Public method	CheckOut	Checks out the object to particular user
Protected method	Invalidate	Sets this provider as invalid (Inherited from AbstractProvider.)
Public method Static member	IsObjectExtensionVersioned	Determines whether the file with the specified extension (case insensitive) is versioned on site specified by name.
Public method Static member	IsVersionMajor	Indicates if specified version is major version
Public method Static member	MakeVersionMajor	Make major version from specified version
Public method Static member	ObjectHasVersions	Indicates if object has at least one version.
Public method	ProcessWebFarmTask	Runs the processing of specific web farm task for current provider (Inherited from AbstractProvider.)
Protected method	Register	Registers current provider in providers collection (Inherited from AbstractProvider.)
Public method Static member	RestoreObject(Int32, Boolean)	Restores object, optionally with its children.
Public method Static member	RestoreObject(Int32, Int32)	Restores object to specified site ID.
Public method Static member	RollbackVersion	Rollbacks object to specified version.
Public method	SetAsDefaultProvider	Sets this object as the default provider (Inherited from AbstractProvider<ProviderType>.)
Public method	UndoCheckOut	Cancels the object checkout.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Public field Static member	RESTORE_ALL	Object versioning restore mode determining that all objects supported in staging will be deleted to recycle bin.
Public field Static member	RESTORE_NONE	Object versioning restore mode determining that objects will be deleted permanently.
Public field Static member	RESTORE_VERSIONEDOBJECTS	Object versioning restore mode determining that versioned objects will be deleted to recycle bin.

Properties

	Name	Description
Public property	IsValid	Indicates if the provider instance is up-to-date and can be used to manage object instances. (Inherited from AbstractProvider.)
Protected property	ProviderName	Provider name (Inherited from AbstractProvider.)