IRISLIB database
All Classes Namespaces Functions Variables Pages
File Class Reference

This class is used internally by InterSystems. More...

Inheritance diagram for File:
Collaboration diagram for File:

Public Member Functions

_.Library.Status CheckIn (_.Library.String InternalName, _.Library.String Description)
 Check this routine/class/csp file into source control.
 
_.Library.String ExternalName (_.Library.String InternalName)
 Convert the internal name, e.g. More...
 
_.Library.Status GetStatus (_.Library.String InternalName, _.Library.Boolean IsInSourceControl, _.Library.Boolean Editable, _.Library.Boolean IsCheckedOut, _.Library.String UserCheckedOut)
 Return information about this entity.
 
_.Library.Boolean IsInSourceControl (_.Library.String InternalName)
 Returns true if this item is in source control and false otherwise.
 
_.Library.Status OnAfterCompile (_.Library.String InternalName)
 Called after the compile of the item is done.
 
_.Library.Status OnAfterSave (_.Library.String InternalName, _.Library.RegisteredObject Object)
 This is called after the item has been saved to the database. More...
 
 OnBeforeTimestamp (_.Library.String InternalName)
 Called before Studio checks for the timestamp of an item.
 
- Public Member Functions inherited from Base
_.Library.Status AddToSourceControl (_.Library.String InternalName, _.Library.String Description)
 Called to add this item to source control.
 
_.Library.Status AfterUserAction (_.Library.Integer Type, _.Library.String Name, _.Library.String InternalName, _.Library.Integer Answer, _.Library.String Msg, _.Library.Boolean Reload)
 This is called after the <method>UserAction</method> and after any template is run or dialog is displayed. More...
 
_.Library.Status CheckOut (_.Library.String InternalName, _.Library.String Description)
 Check this routine/class/csp file out of source control.
 
_.Library.Status GetLatest (_.Library.String InternalName)
 Get the latest version of this file from source control.
 
_.Library.Status OnMenuItem (_.Library.String MenuName, _.Library.String InternalName, _.Library.String SelectedText, _.Library.Boolean Enabled, _.Library.String DisplayName)
 This is called for every menu item returned to Studio to allow the menu to be enabled/disabled without. More...
 
_.Library.Status OnPortalCreate (_.ZEN.proxyObject pUserData)
 Callback invoked when the portal-based Source Control hooks instantiate the source control class. More...
 
_.Library.Status RemoveFromSourceControl (_.Library.String InternalName, _.Library.String Description)
 Called to delete this item from source control.
 
_.Library.Status UndoCheckout (_.Library.String InternalName)
 Undo the checkout of this item.
 
_.Library.Status UserAction (_.Library.Integer Type, _.Library.String Name, _.Library.String InternalName, _.Library.String SelectedText, _.Library.String Action, _.Library.String Target, _.Library.String Msg, _.Library.Boolean Reload)
 This is called when the user performs an action that may need to interact with. More...
 
- Public Member Functions inherited from Base
_.Library.Boolean IsReadOnly (_.Library.String InternalName)
 Return true if this item should be marked as read only. More...
 
_.Library.Integer ItemIconState (_.Library.String InternalName)
 Used to allow Studio to display different icons in open dialog or project window etc. More...
 
_.Library.Status Login (_.Library.String Name, _.Library.String Password)
 Perform any login step here.
 
_.Library.Status Logout ()
 Perform any logout step here.
 
_.Library.Status OnAfterClassCompile (_.Library.String List, _.Library.Integer Level, _.Library.String qstruct, _.Library.Status Status)
 Called in the class compiler after we have compiled all the classes before we exit. More...
 
_.Library.Status OnAfterDelete (_.Library.String InternalName)
 Called after an item is deleted.
 
_.Library.Status OnAfterLoad (_.Library.String InternalName, _.Library.RegisteredObject Object)
 This is called after the item is loaded but before it is sent to Studio. More...
 
_.Library.Status OnAfterStorage (_.Library.String InternalName, _.Library.String Location)
 This is called if you compile a class and the compilation updates the class storage. More...
 
_.Library.Status OnBeforeClassCompile (_.Library.String List, _.Library.Integer Level, _.Library.String qstruct)
 Called in the class compiler after we have resolved the list of classes to be compiled but. More...
 
_.Library.Status OnBeforeCompile (_.Library.String InternalName, _.Library.String qstruct)
 Called before the compile of the item is done. More...
 
_.Library.Status OnBeforeDelete (_.Library.String InternalName)
 Called before an 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.String Location, _.Library.RegisteredObject Object)
 Called before the item is saved to the database it is passed. 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...
 

Static Public Member Functions

_.Library.Status UpdateSources ()
 Update the ^Sources information with the file dates after a running a build.
 
- Static Public Member Functions inherited from Base
 GetPortalPageOptions (_.Library.String pPageURL, _.Library.String pOptions)
 API to give developers control over the HTML environment. More...
 
- Static Public Member Functions inherited from Base
_.Library.String IsGenerated (_.Library.String Name)
 Return 1 if you wish this item to appear as if it is 'generated' when opened in Studio,. More...
 
_.Library.Status OnAfterAllClassCompile (_.Library.String List, _.Library.Integer Level, _.Library.String qstruct, _.Library.Status Status)
 Called in the activated source control class after we have compiled all the classes but before we exit. More...
 
_.Library.Status OnBeforeAllClassCompile (_.Library.String List, _.Library.Integer Level, _.Library.String qstruct)
 Called in the activated source control class before starting a compile after we have resolved the list of classes. More...
 

Static Private Member Functions

_.Library.String __ExtName (_.Library.String InternalName)
 Return filename of this item.
 
_.Library.String __Name (_.Library.String InternalName)
 Return the name of this item without the prefix to be added by ExtName.
 

Additional Inherited Members

- Public Attributes inherited from Base
 IconStatus
 Can be set to determine if we wish to report the source control status of the document in the project window. More...
 
 MainJob
 $Job number of the main Studio process or blank if this is the main Studio connection. More...
 
 Modified
 If the root node is set to 1 then calls to the source control hooks will keep track if the. More...
 
 StudioVersion
 Version of Studio that is connecting to this server. More...
 
 Username
 The username of this source control user. More...
 
- Static Public Attributes inherited from Base
 Flags = None
 Used to control which dialogs appear in Studio. 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

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.

Member Function Documentation

◆ ExternalName()

_.Library.String ExternalName ( _.Library.String  InternalName)

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.

Reimplemented from Base.

◆ OnAfterSave()

_.Library.Status OnAfterSave ( _.Library.String  InternalName,
_.Library.RegisteredObject  Object 
)

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.

Reimplemented from Base.