InterSystems IRIS Data Platform 2020.4 > Class Reference > %SYS namespace > %XML.Exchange.ChangeControlBase

%XML.Exchange.ChangeControlBase

class %XML.Exchange.ChangeControlBase extends %Library.RegisteredObject

Configuration Management Change Control Base
This class is the change control superclass. It does nothing but provide interface for the real extensibility classes to use. Subclass from this and implement the methods as required.

Property Inventory

Method Inventory

Properties

property Username as %Library.Username;
The username of this source control user.
Property methods: UsernameDisplayToLogical(), UsernameGet(), UsernameIsValid(), UsernameLogicalToDisplay(), UsernameLogicalToOdbc(), UsernameNormalize(), UsernameSet()

Methods

method %AfterDelete(InternalName As %String) as %Status [ Language = objectscript ]
Internal use event.
method %AfterDeleteTrigger(InternalName As %String) as %Status [ Language = objectscript ]
Internal use trigger.
method %AfterInsertTrigger(InternalName As %String, Values As %String) as %Status [ Language = objectscript ]
Internal use trigger.
method %AfterLoad(InternalName As %String, Object As %RegisteredObject = $$$NULLOREF) as %Status [ Language = objectscript ]
Internal use event.
method %AfterSave(InternalName As %String, Object As %RegisteredObject = $$$NULLOREF, Insert As %Boolean) as %Status [ Language = objectscript ]
Internal use event.
method %AfterUpdateTrigger(InternalName As %String, Values As %String) as %Status [ Language = objectscript ]
Internal use trigger.
method %BeforeDelete(InternalName As %String) as %Status [ Language = objectscript ]
Internal use event.
method %BeforeDeleteTrigger(InternalName As %String) as %Status [ Language = objectscript ]
Internal use trigger.
method %BeforeInsertTrigger(InternalName As %String, Values As %String) as %Status [ Language = objectscript ]
Internal use trigger. Note: Id has already been allocated when the before insert trigger is fired.
method %BeforeLoad(InternalName As %String) as %Status [ Language = objectscript ]
Internal use event.
method %BeforeSave(InternalName As %String, Object As %RegisteredObject = $$$NULLOREF, Insert As %Boolean) as %Status [ Language = objectscript ]
Internal use event. Note: Internal ids are not allocated to new objects prior to this event.
method %BeforeUpdateTrigger(InternalName As %String, Values As %String) as %Status [ Language = objectscript ]
Internal use trigger.
method %OnClose() as %Status [ Language = objectscript ]
Call the LogOut() method before the object closes.
final method %OnNew(initval As %String) as %Status [ Language = objectscript ]
This just calls the Login() to perform an initialisation. Note that this is called automatically via the %XML.Exchange.ChangeControlInterface class, do not call %New directly.
method Login(Name As %String, Password As %String) as %Status [ Language = objectscript ]
Perform any login step here.
method Logout() as %Status [ Language = objectscript ]
Perform any logout step here.
method OnAfterDelete(InternalName As %String) as %Status [ Language = objectscript ]
Called after a Exchange Item is deleted.
method OnAfterLoad(InternalName As %String) as %Status [ Language = objectscript ]
This is called after the Exchange Item is loaded.
method OnAfterSave(InternalName As %String, Insert As %Boolean) as %Status [ Language = objectscript ]
This is called after the Exchange Item has been saved to the database.
method OnBeforeDelete(InternalName As %String) as %Status [ Language = objectscript ]
Called before a Exchange Item is deleted. Returning an error code prevents the delete from occurring.
method OnBeforeLoad(InternalName As %String) as %Status [ Language = objectscript ]
This is called before the actual load of data to give the chance to load the Exchange Item from an external format. Note: This event is not fired prior to an update via SQL.
method OnBeforeSave(InternalName As %String, Insert As %Boolean) as %Status [ Language = objectscript ]
Called before the Exchange Item is saved to the database. If you quit with an error value then it will abort the save.

Inherited Members

Inherited Methods

Feedback