This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRISOpens in a new window, see the InterSystems IRIS Migration Guide and Migrating to InterSystems IRIS, both available on the WRC Distributions pageOpens in a new window (login required).


class %Studio.SourceControl.File extends %Studio.SourceControl.Base

This class is used internally by InterSystems. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

Method Inventory (Including Private)

Methods (Including Private)

method CheckIn(InternalName As %String, Description As %String) as %Status
Check this routine/class/csp file into source control.
private classmethod ExtName(InternalName As %String) as %String
Return filename of this item
method ExternalName(InternalName As %String) as %String
Inherited description: Convert the internal name, e.g. TEST.MAC to an external name that is used to export the routine/class/csp item. This is often a filename to write the file out to.
method GetStatus(InternalName As %String, ByRef IsInSourceControl As %Boolean, ByRef Editable As %Boolean, ByRef IsCheckedOut As %Boolean, ByRef UserCheckedOut As %String) as %Status
Inherited description: Return information about this entity.
method IsInSourceControl(InternalName As %String) as %Boolean
Inherited description: Returns true if this item is in source control and false otherwise.
private classmethod Name(InternalName As %String) as %String
Return the name of this item without the prefix to be added by ExtName
method OnAfterCompile(InternalName As %String) as %Status
Inherited description: Called after the compile of the item is done.
method OnAfterSave(InternalName As %String, Object As %RegisteredObject) as %Status
Inherited description: This is called after the item has been saved to the database. It may be passed a reference to the object representing the item just saved. It can be use to export this documement to an external form for example.
method OnBeforeLoad(InternalName As %String, display As %Boolean = 1) as %Status
Inherited description: This is called before the actual load of data to give the chance to load the item from an external format.
method OnBeforeTimestamp(InternalName As %String)
Inherited description: Called before Studio checks for the timestamp of an item.
classmethod UpdateSources() as %Status
Update the ^Sources information with the file dates after a running a build

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)

FeedbackOpens in a new window