Class for storing changes to environment. More...

Inheritance diagram for Change:

[legend]

Collaboration diagram for Change:

[legend]

Public Member Functions
_.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...

Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. 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	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. 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...

Static Public Member Functions
_.Library.Status	DisplayUncommitted (UncommittedList, IncludeRevert)
	Displays a list of Uncommitted items from the Uncommitted queue to the output device. More...

_.Library.Status	GetUncommitted (Filename, Action, InternalName, ChangedBy, Source, Updated, P4Issued, CCR, Name)
	Retrieves the details from the Uncommitted queue of an Uncommitted item.

_.Library.Numeric	InstanceVersion ()
	Returns value the Major.Minor version for this instance, so it can be used in comparison code which makes sure certain features are used in appropriate versions.

_.Library.Boolean	IsUncommitted (Filename, ID)
	Returns Boolean value indicating whether or not an item is Uncommitted.

_.Library.Status	ListUncommitted (UncommittedList, IncludeRevert, RefreshUncommitted)
	Lists the Uncommitted items from the Uncommitted queue. More...

_.Studio.SourceControl.Change	OpenUncommitted (Filename)
	Returns uncommited change object.

_.Library.Status	RefreshUncommitted (Display, IncludeRevert)
	Goes through Uncommitted queue and removes any items of action 'edit' or 'add' which are ReadOnly or non-existent on the filesystem.

_.Library.Status	RemoveAllUncommitted (Display, IncludeRevert)
	Removes all Uncommitted items from the Uncommitted queue.

_.Library.Status	RemoveUncommitted (FileList, Display, Revert, ActiveCommit, CommitCCR)
	Removes one or more Uncommitted items from the Uncommitted queue and changes the exported file to Reaonly (except for reverts of Adds, or new CSP files within the Perforce root) More...

_.Library.Status	SetUncommitted (Filename, Action, InternalName, ChangedBy, Source, _.Library.Boolean P4Issued, CCR, Name, EnforceSourcesPath)
	Sets the details for a new Uncommitted item into the Uncommitted queue.

_.Library.Status	UpdateUncommitted (Filename, Action, InternalName, ChangedBy, Source, Updated, P4Issued, CCR, Name)
	Update the details for an Uncommitted item in the Uncommitted queue.

Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Public Attributes
	Action
	Action for this change. More...

	ActivelyCommitted
	Flag indicating whether or not this change was committed to Perforce via Source/Change control tools. More...

	BackupName
	Returns the name of the backup file for this Item in the file system. More...

	CCR
	When this change was first created, this CCR was associated with it for tracking purposes (optional field) More...

	ChangedBy
	User who made this change, and for uncommitted changes this is the person who has it "checked out". More...

	Committed
	Flag indicating whether or not this change has been committed to Perforce. More...

	CommittedTime
	Time when this change was committed to Perforce (either via an ItemSet, the Studio CheckIn page or through a P4V) More...

	CommittedTimeDisplay
	Display the CommittedTime field, showing "Uncommitted" for changes that have not yet been committed. More...

	ExternalName
	Returns the name of this Item in the file system. More...

	InternalName
	Name used within instance to refer to this changed item. More...

	ItemFile
	Location where this item is stored on disk. More...

	Name
	Human readable Name referring to this changed item. More...

	P4Issued
	Time of when the P4 command was issued to Perforce More...

	Source
	Utility by which this change was made. More...

	Tier2
	Determine if current change is sourced from a tier 2 change control environment. More...

	UpdatedTime
	Last time this change was saved locally. More...

Static Public Attributes
	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	SrcVer = None
	This Parameter should be updated when synced from Perforce.

	Version = None
	Revision number of this class when compiled as part of the //custom_ccrs/_common/config/... More...

Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT More...

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

Class for storing changes to environment.

Member Function Documentation

◆ OnAddToSaveSet()

_.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,.

either because Save() was invoked on this object or on an object that references this object. OnAddToSaveSet can modify the current object. It can also add other objects to the current SaveSet by invoking AddToSaveSet or remove objects by calling RemoveFromSaveSet.

If this method returns an error status then Save() will fail and the transaction will be rolled back.

◆ DisplayUncommitted()

_.Library.Status DisplayUncommitted	(	UncommittedList,
		IncludeRevert
	)

static

Displays a list of Uncommitted items from the Uncommitted queue to the output device.

Only lists items with action of type 'revert' if the IncludeRevert flag is passed as true

◆ ListUncommitted()

_.Library.Status ListUncommitted	(	UncommittedList,
		IncludeRevert,
		RefreshUncommitted
	)

static

Lists the Uncommitted items from the Uncommitted queue.

Only lists items with action of type 'revert' if the IncludeRevert flag is passed as true

◆ RemoveUncommitted()

_.Library.Status RemoveUncommitted	(	FileList,
		Display,
		Revert,
		ActiveCommit,
		CommitCCR
	)

static

Removes one or more Uncommitted items from the Uncommitted queue and changes the exported file to Reaonly (except for reverts of Adds, or new CSP files within the Perforce root)

Default assumed behavior is that the the change was not reverted, and that it was actively committed to Perforce

If the method calling does not know whether it was reverted or committed to Perforce, then it should pass Revert = 0 and ActiveCommit = 0, indicating that the change might have been reverted and the Perforce history should be checked for the definitive answer.

The Revert, ActiveCommit, and CommitCCR arguments only impact the behavior if ^SYS("SourceControl","ChangeConfig","KeepHistory")=1, which means Change objects should have their Committed flag set to 1 and be saved for historical reference, rather than just deleting the Change objects when RemoveUncommitted() is called.

Arguments are as follows:

FileList - the name of the file to revert, or an array subscripted by filenames (e.g. FileList("C:\Perforce\custom_ccrs\us\ISCX\TESTSYS\cls\User\Test.xml")="")
Display - boolean flag controlling whether to display the results to standard output (defaults to '1')
Revert - boolean flag controlling whether to revert a checkout which would delete the change from the change history table (defaults to '0')
ActiveCommit - used for historical tracking purposes for the Studio_SourceControl.Change table
CommitCCR - used for historical tracking purposes for the Studio_SourceControl.Change table

Member Data Documentation

◆ MANAGEDEXTENT

MANAGEDEXTENT = None

static

The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager.

to ignore this class. If set to 1 then the Extent Manager will register globals used by the class and detect collisions. Unmanaged extents (MANAGEDEXTENT = 0) are not checked.
Currently, only classes using default storage (Storage.Persistent) can be managed.

This is required since each Namespace will have it's own Change extent

◆ Version

Version = None

static

Revision number of this class when compiled as part of the //custom_ccrs/_common/config/...

branch.

This version will not be updated (by design) when the class is integrated to other branches. This allows the user to tell what version of the Studio client tools are in use.

◆ Action

Action

Action for this change.

◆ ActivelyCommitted

ActivelyCommitted

Flag indicating whether or not this change was committed to Perforce via Source/Change control tools.

If ActivelyCommitted = 0 for a committed change, then it might have been either reverted or committed directly by a Perforce client and the Perforce history should be checked to see whether or not it was committed

◆ BackupName

BackupName

Returns the name of the backup file for this Item in the file system.

◆ CCR

CCR

When this change was first created, this CCR was associated with it for tracking purposes (optional field)

◆ ChangedBy

ChangedBy

User who made this change, and for uncommitted changes this is the person who has it "checked out".

◆ Committed

Committed

Flag indicating whether or not this change has been committed to Perforce.

◆ CommittedTime

CommittedTime

Time when this change was committed to Perforce (either via an ItemSet, the Studio CheckIn page or through a P4V)

this value should be set in the form $zdt($H,3) (i.e. "0000-00-00 00:00:00" format)

◆ CommittedTimeDisplay

CommittedTimeDisplay

Display the CommittedTime field, showing "Uncommitted" for changes that have not yet been committed.

◆ ExternalName

ExternalName

Returns the name of this Item in the file system.

◆ InternalName

InternalName

Name used within instance to refer to this changed item.

◆ ItemFile

ItemFile

Location where this item is stored on disk.

◆ Name

Name

Human readable Name referring to this changed item.

This will default to the value if InternalName unless it is explicitly set

◆ P4Issued

P4Issued

Time of when the P4 command was issued to Perforce

NOTE - a change can have a non-null P4Issued and still have Committed=0 because a 'p4 edit' will check it out but it is not committed until 'p4 submit'

◆ Source

Source

Utility by which this change was made.

◆ Tier2

Tier2

Determine if current change is sourced from a tier 2 change control environment.

◆ UpdatedTime

UpdatedTime

Last time this change was saved locally.

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Function Documentation

◆ OnAddToSaveSet()

◆ DisplayUncommitted()

◆ ListUncommitted()

◆ RemoveUncommitted()

Member Data Documentation

◆ MANAGEDEXTENT

◆ Version

◆ Action

◆ ActivelyCommitted

◆ BackupName

◆ CCR

◆ ChangedBy

◆ Committed

◆ CommittedTime

◆ CommittedTimeDisplay

◆ ExternalName

◆ InternalName

◆ ItemFile

◆ Name

◆ P4Issued

◆ Source

◆ Tier2

◆ UpdatedTime