Skip to main content

%Studio.SASchemaUtil

Class %Studio.SASchemaUtil Extends %RegisteredObject [ System = 3 ]

This class is used internally by InterSystems IRIS.
This internal utility class provides an API for serving StudioAssist Schemas (SASchema) for use by Studio.

Parameters​

DELIMITER​

Parameter DELIMITER = ":";

Methods​

getSchemaDefinition​

ClassMethod getSchemaDefinition(pSchemaNameSpace As %String, Output pOutput As %String) As %Status

getSchemaDefinitionIntoCacheTemp​

ClassMethod getSchemaDefinitionIntoCacheTemp(pSchemaNameSpace As %String, pIndex As %String) As %Status

return the SASchema definition to the Studio

loadSchema​

ClassMethod loadSchema(pSchemaNameSpace As %String, pForce As %Boolean = 0, pForeground As %Boolean = 0, ByRef pIsSpawned As %Boolean = 0) As %Status

load the SASchema into the ^IRIS.SASchema global

isSchemaUpToDate​

ClassMethod isSchemaUpToDate(pSchemaNameSpace As %String) As %Boolean

returns if the SASchema is up-to-date

%GenerateSchema​

ClassMethod %GenerateSchema(pSchemaNameSpace As %String, pMonikerName As %String, pMonikerData As %String) As %Status [ Internal ]

Do the actual work of generating Schema information.

getSchemaMoniker​

ClassMethod getSchemaMoniker(pSchemaSpec As %String, Output pMonikerType, pMonikerName, pMonikerData, Output pRootClasses As %String) As %String

returnCorrelated​

ClassMethod returnCorrelated(xdata As %Dictionary.XDataDefinition, ByRef sc As %Status) As %RegisteredObject [ Internal ]

Used to return the correlated object from an Xdata block

readSASchemaFromStream​

ClassMethod readSASchemaFromStream(pStream, pSchemaNameSpace, pChecksum) As %Status

purge​

ClassMethod purge(pSchemaNameSpace As %String) As %Status

Purge the cached SASchema information for the given schema namespace.

purgeAll​

ClassMethod purgeAll() As %Status

Purge all cached SASchema information