ChangeControlBase Class Reference

Configuration Management Change Control Base
More...

Inheritance diagram for ChangeControlBase:

Collaboration diagram for ChangeControlBase:

Public Member Functions
_.Library.Status	Login (_.Library.String Name, _.Library.String Password)
	Perform any login step here.
_.Library.Status	Logout ()
	Perform any logout step here.
_.Library.Status	OnAfterDelete (_.Library.String InternalName)
	Called after a Exchange Item is deleted.
_.Library.Status	OnAfterLoad (_.Library.String InternalName)
	This is called after the Exchange Item is loaded.
_.Library.Status	OnAfterSave (_.Library.String InternalName, _.Library.Boolean Insert)
	This is called after the Exchange Item has been saved to the database.
_.Library.Status	OnBeforeDelete (_.Library.String InternalName)
	Called before a Exchange Item is deleted. More...
_.Library.Status	OnBeforeLoad (_.Library.String InternalName)
	This is called before the actual load of data to give the chance. More...
_.Library.Status	OnBeforeSave (_.Library.String InternalName, _.Library.Boolean Insert)
	Called before the Exchange Item is saved to the database. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	Username
	The username of this source control user. More...

Private Member Functions
_.Library.Status	AfterDelete (_.Library.String InternalName)
	Internal use event.
_.Library.Status	AfterDeleteTrigger (_.Library.String InternalName)
	Internal use trigger.
_.Library.Status	AfterInsertTrigger (_.Library.String InternalName, _.Library.String Values)
	Internal use trigger.
_.Library.Status	AfterLoad (_.Library.String InternalName, _.Library.RegisteredObject Object)
	Internal use event.
_.Library.Status	AfterSave (_.Library.String InternalName, _.Library.RegisteredObject Object, _.Library.Boolean Insert)
	Internal use event.
_.Library.Status	AfterUpdateTrigger (_.Library.String InternalName, _.Library.String Values)
	Internal use trigger.
_.Library.Status	BeforeDelete (_.Library.String InternalName)
	Internal use event.
_.Library.Status	BeforeDeleteTrigger (_.Library.String InternalName)
	Internal use trigger.
_.Library.Status	BeforeInsertTrigger (_.Library.String InternalName, _.Library.String Values)
	Internal use trigger. More...
_.Library.Status	BeforeLoad (_.Library.String InternalName)
	Internal use event.
_.Library.Status	BeforeSave (_.Library.String InternalName, _.Library.RegisteredObject Object, _.Library.Boolean Insert)
	Internal use event. More...
_.Library.Status	BeforeUpdateTrigger (_.Library.String InternalName, _.Library.String Values)
	Internal use trigger.
_.Library.Status	OnClose ()
	Call the <method>LogOut</method> method before the object closes.
_.Library.Status	OnNew (_.Library.String initval)
	This just calls the <method>Login</method> to perform an initialisation. More...

Additional Inherited Members
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Detailed Description

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.

Member Function Documentation

BeforeInsertTrigger()

_.Library.Status BeforeInsertTrigger ( _.Library.String  InternalName, _.Library.String  Values  )

private

Internal use trigger.

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

BeforeSave()

_.Library.Status BeforeSave ( _.Library.String  InternalName, _.Library.RegisteredObject  Object, _.Library.Boolean  Insert  )

private

Internal use event.

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

OnNew()

_.Library.Status OnNew ( _.Library.String  initval )

private

This just calls the <method>Login</method> to perform an initialisation.

Note that this is called automatically via the <class>XML.Exchange.ChangeControlInterface</class> class, do not call New directly.

OnBeforeDelete()

_.Library.Status OnBeforeDelete

(

_.Library.String

InternalName

)

Called before a Exchange Item is deleted.

Returning an error code prevents the delete from occurring.

OnBeforeLoad()

_.Library.Status OnBeforeLoad

(

_.Library.String

InternalName

)

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.

OnBeforeSave()

_.Library.Status OnBeforeSave	(	_.Library.String	InternalName,
		_.Library.Boolean	Insert
	)

Called before the Exchange Item is saved to the database.

If you quit with an error

value then it will abort the save.

Member Data Documentation

Username

Username

The username of this source control user.