Class Reference
IRIS for UNIX 2019.3
InterSystems: The power behind what matters   
Documentation  Search
  [ENSLIB] >  [%CSP] >  [Portal] >  [SourceControl] >  [Util]
Private  Storage   

abstract class %CSP.Portal.SourceControl.Util

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
9


Summary

Methods
CreateSourceControl GetCurrentProject GetFullProjectName GetSourceControlClass
IsEnabled IsProjectRequired SetCurrentProject SetProjectRequired

Subclasses
%CSP.Portal.SourceControl.Base Ens.Util.SourceControl

Methods

• classmethod CreateSourceControl(Output pSourceControl As %Studio.SourceControl.Base, Output pCreated As %Boolean, Output pUsername As %String, pUserData As %ZEN.proxyObject = "") as %Status
Create an instance of a Source Control object
• classmethod GetCurrentProject(Output pLoaded As %Boolean) as %String [ ZenMethod ]
Helper method to retrieve the current project for the CSP session, along with a flag to indicate whether the OnBeforeLoad() and OnAfterLoad() source control hooks have been executed for the project.
• classmethod GetFullProjectName(pProjectName As %String = "")
Return a project's full name, including a ".PRJ" extension.
• classmethod GetSourceControlClass() as %String
Return the source control class which is to be used in the current namespace. If source control hooks are not enabled, an empty string is returned.
• classmethod IsEnabled(pNamespace As %String = $namespace) as %Boolean
Determine whether source control is enabled for the Management Portal in the specified namespace. The default is to return the flag for the current namespace.
• classmethod IsProjectRequired() as %Boolean
Helper method to indicate whether the source control hooks in the current production-enabled namespace need a project defined.
• classmethod SetCurrentProject(pProjectName As %String, pLoaded As %Boolean = 0) [ ZenMethod ]
Helper method to save the name of the current project and whether its OnBeforeLoad() and OnAfterLoad() callbacks have been executed. The data is saved in the current CSP session data, so will be cleaned up when the user logs out.
• classmethod SetProjectRequired(pNewValue As %Boolean = 0, Output pOldValue As %Boolean) as %Status
Enable or disable the flag indicating whether the source control class used in the current namespace requires a specific project to be selected for the source control hooks to operate correctly.


Copyright (c) 2019 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.