This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %XML.Exchange.ChangeControlInterface


class %XML.Exchange.ChangeControlInterface

Configuration Management Change Control Interface This provides the interface may be used to communicate with the change control class.

Method Inventory (Including Private)

Methods (Including Private)

final classmethod ChangeControlClassGet() as %String
Return the name of the change control class we should use for this namespace. If we return "" then change control is not enabled in this namespace.
final classmethod ChangeControlClassSet(val As %String = "") as %Status
Set the name of the change control class we should use for this namespace. Set the value to "" to disable change control in this namespace.
final classmethod ChangeControlCreate(Name As %String, Password As %String, ByRef Created As %Boolean, ByRef Flags As %Integer, Output Username As %String, Version As %String = "", ByRef Reload As %String) as %Status
Creates an instance of the change control class stored in the local variable '%ChangeControl' this is used by the load/save functions to import export the routine to the external change control class.

It also returns Created which is true if the change control class was created correctly.

classmethod ExtensionClassesClose(ByRef qHandle As %Binary) as %Status
classmethod ExtensionClassesExecute(ByRef qHandle As %Binary) as %Status
classmethod ExtensionClassesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod ExternalName(InternalName As %String) as %String
Returns the external name of this file
classmethod GetStatus(InternalName As %String, ByRef IsInChangeControl As %Boolean, ByRef Editable As %Boolean, ByRef IsCheckedOut As %Boolean, ByRef UserCheckedOut As %String, ByRef Reload As %Boolean) as %Status
Return information about this entity. The Reload parameter is returned by this function and is true if the status check changed the item in Cache and so may need to be reloaded.


query ExtensionClasses()
Selects Name As %String, Description As %String