Skip to main content

%XML.Exchange.ChangeControlBase

Class %XML.Exchange.ChangeControlBase Extends %RegisteredObject [ System = 4 ]

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.

Properties​

Username​

Property Username As %Library.Username;

The username of this source control user.

Methods​

%OnNew​

Method %OnNew(initval As %String) As %Status [ Final ]

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.

%OnClose​

Method %OnClose() As %Status

Call the LogOut method before the object closes.

Login​

Method Login(Name As %String, Password As %String) As %Status

Perform any login step here.

Logout​

Method Logout() As %Status

Perform any logout step here.

OnBeforeLoad​

Method OnBeforeLoad(InternalName As %String) As %Status

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.

OnAfterLoad​

Method OnAfterLoad(InternalName As %String) As %Status

This is called after the Exchange Item is loaded.

OnBeforeSave​

Method OnBeforeSave(InternalName As %String, Insert As %Boolean) As %Status

Called before the Exchange Item is saved to the database. If you quit with an error value then it will abort the save.

OnAfterSave​

Method OnAfterSave(InternalName As %String, Insert As %Boolean) As %Status

This is called after the Exchange Item has been saved to the database.

OnBeforeDelete​

Method OnBeforeDelete(InternalName As %String) As %Status

Called before a Exchange Item is deleted. Returning an error code prevents the delete from occurring.

OnAfterDelete​

Method OnAfterDelete(InternalName As %String) As %Status

Called after a Exchange Item is deleted.

%BeforeLoad​

Method %BeforeLoad(InternalName As %String) As %Status

Internal use event.

%AfterLoad​

Method %AfterLoad(InternalName As %String, Object As %RegisteredObject = {$$$NULLOREF}) As %Status

Internal use event.

%BeforeSave​

Method %BeforeSave(InternalName As %String, Object As %RegisteredObject = {$$$NULLOREF}, Insert As %Boolean) As %Status

Internal use event. Note: Internal ids are not allocated to new objects prior to this event.

%AfterSave​

Method %AfterSave(InternalName As %String, Object As %RegisteredObject = {$$$NULLOREF}, Insert As %Boolean) As %Status

Internal use event.

%BeforeDelete​

Method %BeforeDelete(InternalName As %String) As %Status

Internal use event.

%AfterDelete​

Method %AfterDelete(InternalName As %String) As %Status

Internal use event.

%BeforeInsertTrigger​

Method %BeforeInsertTrigger(InternalName As %String, Values As %String) As %Status

Internal use trigger. Note: Id has already been allocated when the before insert trigger is fired.

%AfterInsertTrigger​

Method %AfterInsertTrigger(InternalName As %String, Values As %String) As %Status

Internal use trigger.

%BeforeUpdateTrigger​

Method %BeforeUpdateTrigger(InternalName As %String, Values As %String) As %Status

Internal use trigger.

%AfterUpdateTrigger​

Method %AfterUpdateTrigger(InternalName As %String, Values As %String) As %Status

Internal use trigger.

%BeforeDeleteTrigger​

Method %BeforeDeleteTrigger(InternalName As %String) As %Status

Internal use trigger.

%AfterDeleteTrigger​

Method %AfterDeleteTrigger(InternalName As %String) As %Status

Internal use trigger.