Class Reference
IRIS for UNIX 2019.2
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%XML] >  [Exchange] >  [ChangeControlBase]
Private  Storage   

class %XML.Exchange.ChangeControlBase extends %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.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 22


Summary

Properties
Username

Methods
%AddToSaveSet %AfterDelete %AfterDeleteTrigger %AfterInsertTrigger
%AfterLoad %AfterSave %AfterUpdateTrigger %BeforeDelete
%BeforeDeleteTrigger %BeforeInsertTrigger %BeforeLoad %BeforeSave
%BeforeUpdateTrigger %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %Extends
%GetParameter %IsA %IsModified %New
%NormalizeObject %ObjectModified %OnClose %OnNew
%OriginalNamespace %PackageName %RemoveFromSaveSet %SerializeObject
%SetModified %ValidateObject Login Logout
OnAfterDelete OnAfterLoad OnAfterSave OnBeforeDelete
OnBeforeLoad OnBeforeSave


Properties

• property Username as %String;
The username of this source control user.

Methods

• method %AfterDelete(InternalName As %String) as %Status
Internal use event.
• method %AfterDeleteTrigger(InternalName As %String) as %Status
Internal use trigger.
• method %AfterInsertTrigger(InternalName As %String, Values As %String) as %Status
Internal use trigger.
• method %AfterLoad(InternalName As %String, Object As %RegisteredObject = $$$NULLOREF) as %Status
Internal use event.
• method %AfterSave(InternalName As %String, Object As %RegisteredObject = $$$NULLOREF, Insert As %Boolean) as %Status
Internal use event.
• method %AfterUpdateTrigger(InternalName As %String, Values As %String) as %Status
Internal use trigger.
• method %BeforeDelete(InternalName As %String) as %Status
Internal use event.
• method %BeforeDeleteTrigger(InternalName As %String) as %Status
Internal use trigger.
• 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.
• method %BeforeLoad(InternalName As %String) as %Status
Internal use event.
• 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.
• method %BeforeUpdateTrigger(InternalName As %String, Values As %String) as %Status
Internal use trigger.
• method %OnClose() as %Status
Call the LogOut method before the object closes.
• final method %OnNew(initval As %String) as %Status
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
Perform any login step here.
• method Logout() as %Status
Perform any logout step here.
• method OnAfterDelete(InternalName As %String) as %Status
Called after a Exchange Item is deleted.
• method OnAfterLoad(InternalName As %String) as %Status
This is called after the Exchange Item is loaded.
• method OnAfterSave(InternalName As %String, Insert As %Boolean) as %Status
This is called after the Exchange Item has been saved to the database.
• method OnBeforeDelete(InternalName As %String) as %Status
Called before a Exchange Item is deleted. Returning an error code prevents the delete from occurring.
• 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.
• 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.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.