Interface Class Reference

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

Static Public Member Functions
_.Library.Status	AfterUserAction (_.Library.Integer Type, _.Library.String Name, _.Library.String InternalName, _.Library.Integer Answer, _.Library.String Msg, _.Library.Boolean Reload, _.Library.Boolean Editable)
	This class is used internally by InterSystems IRIS. More...
_.Library.String	ExternalName (_.Library.String InternalName)
	Returns the external name of this file.
_.Library.Status	GetStatus (_.Library.String InternalName, _.Library.Boolean IsInSourceControl, _.Library.Boolean Editable, _.Library.Boolean IsCheckedOut, _.Library.String UserCheckedOut, _.Library.Boolean Reload)
	Return information about this entity. More...
_.Library.Boolean	IsGenerated (_.Library.String InternalName)
	Return true if this document is generated from some other item.
_.Library.String	SourceControlClassGet (_.Library.String namespace)
	Return the name of the source control class we should use for this. More...
_.Library.Status	SourceControlClassSet (_.Library.String val, _.Library.String namespace, _.Library.Boolean sys)
	Set the name of the source control class we should use for this. More...
_.Library.Status	SourceControlCreate (_.Library.String Name, _.Library.String Password, _.Library.Boolean Created, _.Library.Integer Flags, _.Library.String Username, _.Library.String Version, _.Library.String Reload, _.Library.String MainJob, _.Library.Integer IconStatus)
	Creates an instance of the source control class stored in the local variable. More...
	Test ()
	Test the creation of the source control class.
_.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, _.Library.Boolean Editable)
	Called when the user makes a change that may require some source control hook interaction.
_.Library.String	normalizeName (_.Library.String InternalName)
	Reformat the InternalName to make sure the type is all in upper case.

Detailed Description

This class is used internally by InterSystems IRIS.

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.

This provides the interface that Studio uses to talk to the source control class.

Member Function Documentation

AfterUserAction()

_.Library.Status AfterUserAction ( _.Library.Integer  Type, _.Library.String  Name, _.Library.String  InternalName, _.Library.Integer  Answer, _.Library.String  Msg, _.Library.Boolean  Reload, _.Library.Boolean  Editable  )

static

This class is used internally by InterSystems IRIS.

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.

This provides the interface that Studio uses to talk to the source control class.

Called after Studio brings up its default dialog from calling <method>OnUserAction</method> to tell

the server what the answer was

GetStatus()

_.Library.Status GetStatus ( _.Library.String  InternalName, _.Library.Boolean  IsInSourceControl, _.Library.Boolean  Editable, _.Library.Boolean  IsCheckedOut, _.Library.String  UserCheckedOut, _.Library.Boolean  Reload  )

static

Return information about this entity.

The Reload parameter is returned by this

function and is true if the status check changed the item and so may need to be reloaded.

SourceControlClassGet()

_.Library.String SourceControlClassGet ( _.Library.String  namespace )

static

Return the name of the source control class we should use for this.

namespace. If we return "" then source control is not enabled in this namespace.

SourceControlClassSet()

_.Library.Status SourceControlClassSet ( _.Library.String  val, _.Library.String  namespace, _.Library.Boolean  sys  )

static

Set the name of the source control class we should use for this.

namespace. Set the value to "" to disable source control in this namespace. Set the value to $char(0) to remove the source control node for this namespace. This is different to setting it to "", which disables it, as removing the node for this namespace will allow a look through to the default source control class for all namespaces.

SourceControlCreate()

_.Library.Status SourceControlCreate ( _.Library.String  Name, _.Library.String  Password, _.Library.Boolean  Created, _.Library.Integer  Flags, _.Library.String  Username, _.Library.String  Version, _.Library.String  Reload, _.Library.String  MainJob, _.Library.Integer  IconStatus  )

static

Creates an instance of the source control class stored in the local variable.

'SourceControl'. This is used by the load/save/compile functions to import/export the routine to the external source control class.

It also returns Created which is true if the source control class was created correctly. Then Flags returns an integer set of flags to determine which dialogs to display in Studio. Studio passes its Version to the server so the server can modify its behavior based on this. The server returns Reload which if "" is set in Studio on a per user basis, but if set to 1 or 0 then this forces the auto reload behavior in Studio to follow this server setting. The MainJob is blank if this process is the main Studio connection, but is the $job of the initial Studio connection job if this is a background job for doing things like find in files, or a big compile. By passing the $job of the main process this background process can co-ordinate with the main job.