Class %Studio.SourceControl.File

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.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		11

Summary

Properties
IconStatus	MainJob	Modified	StudioVersion	Username

Methods
%AddToSaveSet	%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	AddToSourceControl	AfterUserAction
CheckIn	CheckOut	ExternalName	GetLatest
GetPortalPageOptions	GetStatus	IsGenerated	IsInSourceControl
IsReadOnly	ItemIconState	Login	Logout
OnAfterAllClassCompile	OnAfterClassCompile	OnAfterCompile	OnAfterDelete
OnAfterLoad	OnAfterSave	OnAfterStorage	OnBeforeAllClassCompile
OnBeforeClassCompile	OnBeforeCompile	OnBeforeDelete	OnBeforeLoad
OnBeforeSave	OnBeforeTimestamp	OnMenuItem	OnPortalCreate
RemoveFromSourceControl	UndoCheckout	UpdateSources	UserAction

Methods

• method CheckIn(InternalName As %String, Description As %String) as %Status

Check this routine/class/csp file into source control.

• method ExternalName(InternalName As %String) as %String

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

Return information about this entity.

• method IsInSourceControl(InternalName As %String) as %Boolean

Returns true if this item is in source control and false otherwise.

• method OnAfterCompile(InternalName As %String) as %Status

Called after the compile of the item is done.

• method OnAfterSave(InternalName As %String, Object As %RegisteredObject) as %Status

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

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)

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

Class Reference IRIS for UNIX 2024.1.2
Documentation Search