Inheritance diagram for Project:

[legend]

Collaboration diagram for Project:

[legend]

Public Member Functions
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...

_.Library.Status	OnOpen ()
	This callback method is invoked by the <METHOD>Open</METHOD> method to. More...

_.Library.Status	AddItem (_.Library.String name, _.Library.String type)
	Add an item to the project, you can just pass the full name in the name argument and nothing in the. More...

_.Library.Status	Check ()
	Check the project so that if any items are do not exist then we will remove them from the project.

_.Library.Status	Compile (_.Library.String qspec, _, _.Library.String errorlog)
	Compile all the items in this project, using the qspec. More...

_.Library.Status	CreateClone (_.Library.String name)
	Create a clone of this project and then save it with a new name. More...

_.Library.Status	Deploy (_.Library.String deploydir, _.Library.String qspec, _, _.Library.String errorlog, _.Library.Boolean ShowFilename, _.Library.String gbl, _.Library.Boolean removesource)
	Export this project to a DAT file or a global for deployment. More...

_.Library.Status	DeployToFile (_.Library.String file, _.Library.String qspec, _.Library.Boolean removesource)
	Package up this project into a global for deployment and then export this global to the file specified. More...

_.Library.Status	DeployToGbl (_.Library.String gbl, _.Library.String qspec, _.Library.Boolean removesource)
	Package up this project into a global for deployment. More...

_.Library.Status	DeployToStream (_.Library.String qspec, _, _.Library.String errorlog)
	Wrapper to <method>Deploy</method> which returns a binary stream in <property>Stream</property> More...

_.Library.Status	Export (_.Library.String filename, _.Library.String qspec, _.Library.Boolean justproject, _, _.Library.String errorlog, _.Library.String Charset, _.Library.Boolean ShowFilename)
	Export this project in XML format to the filename. More...

_.Library.Status	ExportCDLToStream (_.Library.String classname, _.Library.String qspec, _.Library.String file, _.Library.String Charset)
	Wrapper to ExportCDLList^apiOBJ which returns a stream in <property>stream</property> More...

_.Library.Status	ExportListToStream (_.Library.String list, _.Library.String qspec, _.Library.String file, _.Library.String Charset)
	Wrapper to <method>ExportList</method> which returns a stream in <property>Stream</property> More...

_.Library.Status	ExportRtnToStream (_.Library.String rtnlist, _.Library.String qspec, _.Library.String file, _.Library.String Charset)
	Wrapper to Export^apiRTN which returns a stream in <property>stream</property> More...

_.Library.Status	ExportToStream (_.Library.String qspec, _.Library.Boolean justproject, _, _.Library.String errorlog, _.Library.String file, _.Library.String Charset)
	Wrapper to <method>Export</method> which returns a stream in <property>Stream</property> More...

_.Library.Status	FindInProject (_.Library.String String, _.Library.Boolean WholeWords, _.Library.Boolean CaseSensitive, _.Library.Integer Max, _.Library.Boolean wild)
	Find a particular string inside this project. More...

_.Library.TimeStamp	GetCurrentTimeStamp ()
	Get the on-disk timestamp for the project.

_.Library.String	GetStreamName ()
	Return the name of the stream. More...

_.Library.Status	ImportFromStream (_.Library.String qspec, _, _.Library.String errorlog, _.Library.String imported, _.Library.Boolean listonly, _.Library.String selecteditems)
	Wrapper to <method>Import</method> which is passed a stream in <property>Stream</property> More...

_.Library.Status	ListWebPages (_.Library.String pages, _.Library.String qspec)
	Return comma separated list of items in this project which can be called as web pages.

_.Library.Status	Lock ()
	Lock the project.

_.Library.Status	RemoveAllBreakPoints ()
	Remove all break points from a project. More...

_.Library.Status	RemoveAllWatchPoints ()
	Remove all break points from a project. More...

_.Library.Status	RemoveAllWatchVariables ()
	Remove all watch variables from a project. More...

_.Library.Status	SetStreamName (_.Library.String file)
	This will try and set the <property>Stream</property> to point to the filename file. More...

_.Library.Status	Unlock ()
	Unlock the project.

Public Member Functions inherited from Persistent
_.Library.Status	AcquireLock (_.Library.String locktype)
	Acquires a lock for the current instance. More...

_.Library.Status	LoadData (_.Library.String id)
	LoadData() - loads an object from storage. More...

_.Library.Status	OnAfterSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnBeforeSave (_.Library.Boolean insert)
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	OnReload ()
	This callback method is invoked by the <METHOD>Reload</METHOD> method to. More...

_.Library.Status	OnRollBack ()
	This callback method is invoked by the <METHOD>Save</METHOD> method to. More...

_.Library.Status	ReleaseLock (_.Library.String locktype)
	Releases a lock for the current instance. More...

_.Library.Status	SaveData (_.Library.String id)
	SaveData() - saves an object to disk, checks uniqueness and referential More...

Public Member Functions inherited from SwizzleObject
_.Library.Status	OnJournalObject (_.Library.Integer tranid, _.Library.Integer jrnid, _.Library.String filter)
	This callback method is invoked by the <METHOD>JournalObject</METHOD> method to. 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...

Public Member Functions inherited from Adaptor
_.Library.Status	XMLExport (_.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent, _.Library.Boolean local, _.Net.MIMEPart mimeAttachments)
	Serialize an XML enabled class as an XML document and write. More...

_.Library.Status	XMLExportToStream (_.Stream.Object export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and appends it to a stream. More...

_.Library.Status	XMLExportToString (_.Library.String export, _.Library.String top, _.Library.String format, _.XML.Namespaces namespaces, attrs, _.Library.String createId, _.Library.String typeAttr, oreflist, idlist, _.Library.String initialIndent)
	Serialize an XML enabled class as an XML document and write it to a string. More...

Static Public Member Functions
_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	BackupDeployContent (_.Library.String gbl, _.Library.String backupgbl, _.Library.String qspec)
	Backup the items that will be replaced when installing a deployed set of items to backupgbl

_.Library.Status	Delete (_.Library.String id)
	Delete this project.

_.Library.Status	ExportList (_.Library.String filename, _.Library.String list, _.Library.String qspec, _.Library.String Charset, _.Library.Boolean ShowFilename)
	Export a list of items to the filename specified. More...

_.Library.Status	ExportRtn (_.Library.String rtnlist, _.Library.String qspec, _.Library.String file, _.Library.String Charset, _.Library.Boolean ShowFilename)
	Wrapper to Export^apiRTN which returns a stream in <property>stream</property> More...

_.Library.Status	FindInFiles (_.Library.String String, _.Library.String PatternList, _.Library.Boolean pSystem, _.Library.Boolean WholeWords, _.Library.Boolean CaseSensitive, _.Library.Integer Max, _.Library.String Filter, _.Library.Boolean wild, _.Library.Boolean pGenerated, _.Library.Boolean pMapped)
	Find a particular string inside a list of files. More...

_.Library.Status	FindInFilesRegex (_.Library.String Regex, _.Library.String ItemList, _.Library.Boolean pSystem, _.Library.Boolean pGenerated, _.Library.Integer Max, _.Library.Boolean pMapped)
	Search a list of files, using a Regular Expression. More...

_.Library.TimeStamp	GetDate (_.Library.String name)
	Return the timestamp the project with name was last updated.

_.Library.Status	Import (_.Library.String filename, _.Library.String qspec, _, _.Library.String errorlog, _.Library.String imported, _.Library.Boolean listonly, _.Library.String selecteditems, _.Library.String displayname)
	Import the XML description of routines, classes, CSP files, and projects into this namespace. More...

	InstallFromFile (_.Library.String file, _.Library.String qspec, _.Library.Boolean runinstall, _.Studio.Project project, _.Library.Boolean listonly, _.Library.String backupgbl, _.Library.Boolean validatesig, _.Library.Boolean transaction)
	This will install any routines, classes and globals into the current namespace. More...

	InstallFromGbl (_.Library.String gbl, _.Library.String qspec, _.Library.Boolean runinstall, _.Studio.Project project, _.Library.Integer listonly, _.Library.String backupgbl, _.Library.Boolean validatesig, _.Library.Boolean transaction)
	This will install any routines, classes and globals into the current namespace. More...

_.Library.Status	LockItem (_.Library.String name, _.Library.Boolean lock)
	Lock a project with the name. More...

_.Library.Status	NormalizeName (_.Library.String name, _.Library.String type, _.Library.Boolean skiptype)
	Normalize the name passed in and determine its type.

_.Library.Status	ProjectItemsListFetchRows (_.Library.Binary QHandle, _.Library.Integer FetchCount, _.Library.List RowSet, _.Library.Integer ReturnCount, _.Library.Integer AtEnd)
	ProjectItemsListFetchRows returns the next FetchCount rows in the query.

_.Library.Status	realCompile (qstruct, _, _.Library.String errorlog, _.Library.String itemlist, _.Library.String updatedlist)
	Compile all the items in itemlist. More...

Static Public Member Functions inherited from Persistent
_.Library.Status	DeleteData (_.Library.String id, _.Library.Integer concurrency)
	This method is normally generated by the storage class for persistent classes using. More...

_.Library.Status	KillExtentData (_.Library.Boolean killstreams)
	KillExtentData() - kills extent data in storage. More...

_.Library.Status	OnAfterBuildIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>BuildIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnAfterDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

_.Library.Status	OnAfterPurgeIndices (_.Library.String indexlist)
	This callback method is invoked by the <METHOD>PurgeIndices</METHOD> method after all work is completed. More...

_.Library.Status	OnBeforeBuildIndices (_.Library.String indexlist)

_.Library.Status	OnBeforePurgeIndices (_.Library.String indexlist)

_.Library.Status	OnDelete (_.Library.ObjectIdentity oid)
	This callback method is invoked by the <METHOD>Delete</METHOD> method to. More...

Static Public Member Functions inherited from Adaptor
_.Library.Status	XMLDTD (_.Library.String top, _.Library.String format, _.Library.Boolean input, dtdlist)
	Write the DTD to the current device for this XML enabled class serialized as. More...

_.Library.RegisteredObject	XMLNew (_.XML.Document document, _.Library.Integer node, _.Library.RegisteredObject containerOref)
	Get an instance of an XML enabled class. More...

_.Library.Status	XMLSchema (_.Library.String top, _.Library.String format, _.Library.String namespacePrefix, _.Library.Boolean input, _.Library.Boolean refOnly, schema)
	Write an XML Schema fragment to the current device which describes an XML enabled class and dependent classes. More...

_.Library.String	XMLSchemaNamespace ()
	Get the namespace to which this class belongs for use in schema generation. More...

_.Library.Status	XMLSchemaType (_.XML.Schema schemaInstance, _.XML.Node node, _.Library.String top, _.Library.Boolean encoded, _.Library.Boolean summary, _.Library.Boolean input, _.Library.Boolean refOnly)
	Add a complexType to the schema that is respresented by an <class>XML.Schema</class> instance. More...

Public Attributes
	BreakPoints
	More...

	DebugStepping
	More...

	Defines
	More...

	Description
	More...

	HttpServer
	More...

	Items
	More...

	LastModified
	More...

	Locked
	More...

	Name
	More...

	Projections
	More...

	RunInTerminal
	More...

	Stream
	Temporary stream for passing information between InterSystems IRIS and client system. More...

	StreamName
	Temporary name of the stream. More...

	Target
	More...

	TargetType
	More...

	TerminalPassword
	More...

	TerminalPort
	More...

	TerminalUsername
	More...

	WatchPoints
	More...

	WatchVariables
	More...

Static Public Attributes
	SQLPUBLICSECURITY = None
	Represents a Studio Project. More...

Static Public Attributes inherited from Persistent
	XCOMPACTANCESTRY
	XCOMPACTANCESTRY can be set to a string to replace the value of the %CLASSNAME property (x__classname field) More...

	DATALOCATIONGLOBAL = None
	Global name containing master map data for this class. More...

	DEFAULTGLOBAL = None

	DSCONDITION = None
	DSCONDITION is the expression that will be evaluated before deciding whether certain actions must be taken. More...

	DSINTERVAL = None
	DSINTERVAL is the number of seconds between one DSTIME value and the next. More...

	DSTIME = None
	If the DSTIME parameter is set to AUTO then the most recent filing operation in the current DSTIME value. More...

	EXTENTQUERYSPEC = None
	The EXTENTQUERYSPEC parameter defines the properties to be retrieved in. More...

	EXTENTSIZE = None
	The EXTENTSIZE parameter is used to inform the SQL Query Optimizer More...

	GUIDENABLED = None
	If this parameter is set to 1 then a GUID will be assigned (to the GUID property) to each new object. More...

	IDENTIFIEDBY = None
	The IDENTIFIEDBY parameter can optionally be set to the name. More...

	MANAGEDEXTENT = None
	The MANAGEDEXTENT parameter can be set to 0 (zero) to cause the Extent Manager. More...

	READONLY = None
	READONLY = 1 means that objects can be created, opened but not saved or deleted. More...

	ROWLEVELSECURITY = None
	ROWLEVELSECURITY = 1 \| <property> means that row level security is active and the list More...

	SQLPREVENTFULLSCAN = None
	SQLPREVENTFULLSCAN = 1 means an attempt to prepare a query that will result in a full scan More...

	STORAGEDEFAULT = None
	STORAGEDEFAULT defines the default storage allocation to use for properties in this class. More...

	USEEXTENTSET = None

	VERSIONCLIENTNAME = None
	VERSIONCLIENTNAME can be set to a valid CLIENTNAME (see property CLIENTNAME) value. More...

	VERSIONPROPERTY = None
	VERSIONPROPERTY = <property> means that the <property> in memory will be compared to. More...

Static Public Attributes inherited from SwizzleObject
	DEFAULTCONCURRENCY = None
	DEFAULTCONCURRENCY is the default value for the concurrency formal argument. More...

	JOURNALSTREAM = None
	If OBJJOURNAL is true then the value of the JOURNALSTREAM parameter defines whether or not. More...

	OBJJOURNAL = None
	if OBJJOURNAL is TRUE then inserts, updates and deletes will be logged in ^OBJ.JournalT 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...

Static Public Attributes inherited from Adaptor
	ATTRIBUTEQUALIFIED = None
	ATTRIBUTEQUALIFIED controls the format of exported XML by controlling whether attributes. More...

	ELEMENTQUALIFIED = None
	ELEMENTQUALIFIED controls the format of exported XML. More...

	NAMESPACE = None
	NAMESPACE specifies the XML namespace to be used when projecting the. More...

	SUPPRESSTYPEPREFIX = None
	SUPPRESSTYPEPREFIX allows the type name that refers to this class. More...

	XMLDEFAULTREFERENCE = None
	XMLDEFAULTREFERENCE specifies the default value of the XMLREFERENCE property parameter. More...

	XMLENABLED = None
	If this parameter is true then XML-enabling methods. More...

	XMLFORMAT = None
	The XMLFORMAT parameter controls the generation of the XMLExport and XMLImport. More...

	XMLIGNOREINVALIDATTRIBUTE = None
	The XMLIGNOREINVALIDATTRIBUTE parameter allows the programmer to control handling of unexpected. More...

	XMLIGNOREINVALIDTAG = None
	The XMLIGNOREINVALIDTAG parameter allows the programmer to control handling of unexpected. More...

	XMLIGNORENULL = None
	XMLIGNORENULL allows the programmer to override the default XML handling. More...

	XMLINCLUDEINGROUP = None
	XMLINCLUDEINGROUP allows the programmer to control whether a class is included. More...

	XMLINHERITANCE = None
	If the XMLINHERITANCE parameter is set to "LEFT", then in the case of multiple. More...

	XMLNAME = None
	This parameter provides the default XMLNAME for the class. More...

	XMLNIL = None
	The XMLNIL class parameter controls the use of xsi:nil by XMLExport. More...

	XMLNILNOOBJECT = None
	The XMLNILNOOBJECT parameter allows creation of an object to be skipped for elements. More...

	XMLPREFIX = None
	The XMLPREFIX parameter controls the prefix to be used for the XML namespace that. More...

	XMLSEQUENCE = None
	If the XMLSEQUENCE = 1, then the order of the XML elements must match the. More...

	XMLSUMMARY = None
	The summary fields to be used when an object is referenced are specified. More...

	XMLTYPE = None
	This parameter provides the default XMLTYPE for the class. More...

	XMLUNSWIZZLE = None
	If the XMLUNSWIZZLE parameter is set to 1, then single object. More...

	XMLUSEEMPTYELEMENT = None
	If the XMLUSEEMPTYELEMENT parameter is set to 1, then the empty element shorthand (<tag>) More...

Private Member Functions
_.Library.Integer	IsModified ()
	Returns true (1) if a property of this instance has been modified, otherwise false (0). More...

_.Library.Integer	ObjectModified ()
	This method is somewhat similar to IsModified but it also checks to see if swizzled. More...

Static Private Member Functions
	__searchClassNode (_.Library.String Name, _.Library.String ref, _.Library.String type, _.Library.String NewName, _.Library.String pattern, _.Library.Integer Found, _.Library.String Tree, _.Library.Boolean CaseSensitive, _.Library.Integer Max, _.Library.Boolean Wild)
	Search this class for the string.

	__searchClassNodeRegex (_.Regex.Matcher Matcher, _.Library.String Name, _.Library.String ref, _.Library.String type, _.Library.String NewName, _.Library.Integer Found, _.Library.String Tree, _.Library.Integer Max)
	Search this class for the string.

_.Library.Boolean	__searchItem (_.Library.String pattern, _.Library.String Name, _.Library.Integer Found, _.Library.Boolean wild, _.Library.Boolean CaseSensitive, _.Library.Integer Max, _.Library.String Pattern, _.Library.Boolean WholeWords)
	Search this specific item for the string.

_.Library.Boolean	__searchItemRegex (_.Regex.Matcher Matcher, _.Library.String Name, _.Library.Integer Found, _.Library.Integer Max)
	Search this specific item for the string.

Detailed Description

Represents a Studio Project.

Many methods in this class use the qspec argument, which is a list of flags or qualifiers. See System Flags and Qualifiers.

Member Function Documentation

◆ IsModified()

_.Library.Integer IsModified ( )

private

Returns true (1) if a property of this instance has been modified, otherwise false (0).

A TRUE result does not necessarily mean that any property has actually been changed. If IsModified() returns false then the object has not been modified. There are some situations where we simply cannot efficiently detect a change in value. In these cases we will set the modified status of the property.

Reimplemented from RegisteredObject.

◆ ObjectModified()

_.Library.Integer ObjectModified ( )

private

This method is somewhat similar to IsModified but it also checks to see if swizzled.

references would cause the object to become modified should they be serialized. This works on the assumption that a reference to a persistent object will never be modified if the ID has already been assigned. For references to serial objects, a call to ObjectModified indicates whether or not the serialized value is different. If the reference to a swizzled object is different from the initial object state then the $$$objModAll macro will already return true. Reference the <property>Set code.

Returns true (1) if this instance has been modified, otherwise false (0).

Reimplemented from RegisteredObject.

◆ OnClose()

_.Library.Status OnClose ( )

This callback method is invoked by the <METHOD>Close</METHOD> method to.

provide notification that the current object is being closed.

The return value of this method is ignored.

Reimplemented from RegisteredObject.

◆ OnDelete()

_.Library.Status OnDelete ( _.Library.ObjectIdentity oid )

static

This callback method is invoked by the <METHOD>Delete</METHOD> method to.

provide notification that the object specified by oid is being deleted.

If this method returns an error then the object will not be deleted.

◆ OnOpen()

_.Library.Status OnOpen ( )

This callback method is invoked by the <METHOD>Open</METHOD> method to.

provide notification that the object specified by oid is being opened.

If this method returns an error then the object will not be opened.

Reimplemented from Persistent.

◆ AddItem()

_.Library.Status AddItem	(	_.Library.String	name,
		_.Library.String	type
	)

Add an item to the project, you can just pass the full name in the name argument and nothing in the.

type argument and this will add the correct type information automatically.

◆ Compile()

_.Library.Status Compile	(	_.Library.String	qspec,
			_,
		_.Library.String	errorlog
	)

Compile all the items in this project, using the qspec.

The order

of compilation is INT, CLS, MAC, CSR, CSP, other.

◆ CreateClone()

_.Library.Status CreateClone ( _.Library.String name )

Create a clone of this project and then save it with a new name.

Note that if the

target name already exists then it will be deleted without warning. It is the responsibility of the caller to check if it wishes to overwrite the new name or not.

◆ Deploy()

_.Library.Status Deploy	(	_.Library.String	deploydir,
		_.Library.String	qspec,
			_,
		_.Library.String	errorlog,
		_.Library.Boolean	ShowFilename,
		_.Library.String	gbl,
		_.Library.Boolean	removesource
	)

Export this project to a DAT file or a global for deployment.

The DAT file will be stored in the deploydir

directory.

The qspec are the standard cache objects qualifiers.

◆ DeployToFile()

_.Library.Status DeployToFile	(	_.Library.String	file,
		_.Library.String	qspec,
		_.Library.Boolean	removesource
	)

Package up this project into a global for deployment and then export this global to the file specified.

This can be imported using the <method>InstallFromFile</method>. The qualifiers are used to determine if we should export selectivity information using the /exportselectivity qualifier. Also the /keepsource will determine if we add intermediate compilation files such as User.Test.1.int when you are creating a package containing User.Test.cls. If you pass removesource=1 then it will strip out all source code in the package including class method code, and routines. If the filename ends in .gz or .gzip it will automatically gzip the file.

◆ DeployToGbl()

_.Library.Status DeployToGbl	(	_.Library.String	gbl,
		_.Library.String	qspec,
		_.Library.Boolean	removesource
	)

Package up this project into a global for deployment.

This can be imported using the <method>InstallFromGbl</method>.

The qualifiers are used to determine if we should export selectivity information using the /exportselectivity qualifier. Also the /keepsource will determine if we add intermediate compilation files such as User.Test.1.int when you are creating a package containing User.Test.cls. If you pass removesource=1 then it will strip out all source code in the package including class method code, and routines.

◆ DeployToStream()

_.Library.Status DeployToStream	(	_.Library.String	qspec,
			_,
		_.Library.String	errorlog
	)

Wrapper to <method>Deploy</method> which returns a binary stream in <property>Stream</property>

rather than writing to a file.

◆ Export()

_.Library.Status Export	(	_.Library.String	filename,
		_.Library.String	qspec,
		_.Library.Boolean	justproject,
			_,
		_.Library.String	errorlog,
		_.Library.String	Charset,
		_.Library.Boolean	ShowFilename
	)

Export this project in XML format to the filename.

If the justproject is true then it will only export the project definition, but not any items in this project, otherwise the default behavour is to export all the items in the project to the same XML file.

The qspec are the standard cache objects qualifiers.

◆ ExportCDLToStream()

_.Library.Status ExportCDLToStream	(	_.Library.String	classname,
		_.Library.String	qspec,
		_.Library.String	file,
		_.Library.String	Charset
	)

Wrapper to ExportCDLList^apiOBJ which returns a stream in <property>stream</property>

rather than writing to a file. You pass this a comma separated list of classes, or an array subscripted by the class name. The file is the filename to output this to without the directory.

◆ ExportList()

_.Library.Status ExportList	(	_.Library.String	filename,
		_.Library.String	list,
		_.Library.String	qspec,
		_.Library.String	Charset,
		_.Library.Boolean	ShowFilename
	)

static

Export a list of items to the filename specified.

The list can either be

comma delimited such as 'TEST.MAC,Example.CLS,/csp/samples/loop.csp' or a subscripted array with the first subscript being the name of the item to export. The qspec are the standard ObjectScript qualifiers, if the "d" is passed then it will output status information to the current device.

◆ ExportListToStream()

_.Library.Status ExportListToStream	(	_.Library.String	list,
		_.Library.String	qspec,
		_.Library.String	file,
		_.Library.String	Charset
	)

Wrapper to <method>ExportList</method> which returns a stream in <property>Stream</property>

rather than writing to a file.

◆ ExportRtn()

_.Library.Status ExportRtn	(	_.Library.String	rtnlist,
		_.Library.String	qspec,
		_.Library.String	file,
		_.Library.String	Charset,
		_.Library.Boolean	ShowFilename
	)

static

Wrapper to Export^apiRTN which returns a stream in <property>stream</property>

rather than writing to a file. You pass this a comma separated list of routines or an array subscripted by the routine name. The file is the filename to output this to without the directory.

◆ ExportRtnToStream()

_.Library.Status ExportRtnToStream	(	_.Library.String	rtnlist,
		_.Library.String	qspec,
		_.Library.String	file,
		_.Library.String	Charset
	)

Wrapper to Export^apiRTN which returns a stream in <property>stream</property>

rather than writing to a file. You pass this a comma separated list of routines or an array subscripted by the routine name. The file is the filename to output this to without the directory.

◆ ExportToStream()

_.Library.Status ExportToStream	(	_.Library.String	qspec,
		_.Library.Boolean	justproject,
			_,
		_.Library.String	errorlog,
		_.Library.String	file,
		_.Library.String	Charset
	)

Wrapper to <method>Export</method> which returns a stream in <property>Stream</property>

rather than writing to a file.

◆ FindInFiles()

_.Library.Status FindInFiles	(	_.Library.String	String,
		_.Library.String	PatternList,
		_.Library.Boolean	pSystem,
		_.Library.Boolean	WholeWords,
		_.Library.Boolean	CaseSensitive,
		_.Library.Integer	Max,
		_.Library.String	Filter,
		_.Library.Boolean	wild,
		_.Library.Boolean	pGenerated,
		_.Library.Boolean	pMapped
	)

static

Find a particular string inside a list of files.

String is the string to search for. The PatternList is the list of items to search. Typically this will be '*.*' but you can specify just MAC and INC files with '*.mac,*.inc' or a list of individual files with 'abc.mac,def.cls'. The acceptable extensions at this time are int,mac,inc,bas,cls,csp,csr,prj,mvm,bam,mvb. The list of matches is written to the screen. If pSystem is true then it also searches system routines and classes (where the source is available) when searching the entire namespace. If WholeWords is true then it will only find whole words and not fragments, it defaults to false. If CaseSensitive is true (the default) then the search is case sensitive, otherwise it is case insensitive. The maximum number of matches it will find can be specified in Max which defaults to 200. If wild is false then the String does not contain any wild cards and so should be treated as a string literal search even if it contains ?*\ characters.

◆ FindInFilesRegex()

_.Library.Status FindInFilesRegex	(	_.Library.String	Regex,
		_.Library.String	ItemList,
		_.Library.Boolean	pSystem,
		_.Library.Boolean	pGenerated,
		_.Library.Integer	Max,
		_.Library.Boolean	pMapped
	)

static

Search a list of files, using a Regular Expression.

Regex is the Regular Expression for the search. The ItemList is the list of items to search. Typically this will be '*.*' but you can specify just MAC and INC files with '*.mac,*.inc' or a list of individual files with 'abc.mac,def.cls'. The acceptable extensions at this time are int,mac,inc,bas,cls,csp,csr,prj,mvm,bam,mvb.
The list of matches is written to the current device.
If pSystem is true then it also searches system routines and classes (where the source is available). If pGenerated is true then it also searches generated items. The maximum number of matches it will find can be specified in Max which defaults to 200.

◆ FindInProject()

_.Library.Status FindInProject	(	_.Library.String	String,
		_.Library.Boolean	WholeWords,
		_.Library.Boolean	CaseSensitive,
		_.Library.Integer	Max,
		_.Library.Boolean	wild
	)

Find a particular string inside this project.

String is the string to search for. The list of matches is written to the screen. If WholeWords is true then it will only find whole words and not fragments, it defaults to false. If CaseSensitive is true (the default) then the search is case sensitive, otherwise it is case insensitive. The maximum number of matches it will find can be specified in Max which defaults to 200. If wild is false then the PatternList does not contain any wild cards and so should be treated as a string literal search even the pattern contains ?*\ characters.

◆ GetStreamName()

_.Library.String GetStreamName ( )

Return the name of the stream.

Used by Studio because it can not access the Stream

property directly

◆ Import()

_.Library.Status Import	(	_.Library.String	filename,
		_.Library.String	qspec,
			_,
		_.Library.String	errorlog,
		_.Library.String	imported,
		_.Library.Boolean	listonly,
		_.Library.String	selecteditems,
		_.Library.String	displayname
	)

static

Import the XML description of routines, classes, CSP files, and projects into this namespace.

This returns the list of items imported in imported separated by commas. You can pass in the qspec to tell it if it should compile these imported elements as well. If listonly is true then it will just return the list of items to import and not import anything. selecteditems is an optional comma separated list of items, if present then it will only import these items and it will skip any item not in this list. The filename may be a comma separated list of files.

◆ ImportFromStream()

_.Library.Status ImportFromStream	(	_.Library.String	qspec,
			_,
		_.Library.String	errorlog,
		_.Library.String	imported,
		_.Library.Boolean	listonly,
		_.Library.String	selecteditems
	)

Wrapper to <method>Import</method> which is passed a stream in <property>Stream</property>

rather than a file.

◆ InstallFromFile()

InstallFromFile	(	_.Library.String	file,
		_.Library.String	qspec,
		_.Library.Boolean	runinstall,
		_.Studio.Project	project,
		_.Library.Boolean	listonly,
		_.Library.String	backupgbl,
		_.Library.Boolean	validatesig,
		_.Library.Boolean	transaction
	)

static

This will install any routines, classes and globals into the current namespace.

from a file created with the <method>DeployToFile</method>. The qualifiers respects the /importselectivity item to determine of we should import selectivity information from this package. If you pass in a Studio.Project in project then this will be returned with all the items in the deployment in gbl added to the project. If listonly is true then nothing will be actually changed in the database, so you can list items. If runinstall is false then if the deployment contains a routine called 'INSTALL' (note not in the database, but in the deployment) then we will not automatically run this after installing the items in this deployment. The default is to run the INSTALL routine if present.

◆ InstallFromGbl()

InstallFromGbl	(	_.Library.String	gbl,
		_.Library.String	qspec,
		_.Library.Boolean	runinstall,
		_.Studio.Project	project,
		_.Library.Integer	listonly,
		_.Library.String	backupgbl,
		_.Library.Boolean	validatesig,
		_.Library.Boolean	transaction
	)

static

This will install any routines, classes and globals into the current namespace.

from a global created with the <method>DeployToGbl</method>. The qualifiers respects the /importselectivity item to determine if we should import selectivity information from this package. If you pass in a Studio.Project in project then this will be returned with all the items in the deployment in gbl added to the project. If listonly is true then nothing will be actually changed in the database, so you can list items. If runinstall is true then if the deployment contains a routine called 'INSTALL' (note not in the database, but in the deployment) then we will automatically run PRE^INSTALL before the installation and ^INSTALL after installing the items in this deployment. The default is to run the INSTALL routine if present. If backupgbl is defined then any items which will be replaced by items in the package are backed up to this global location first. Also if the deployment contains an INSTALL routine then this will be placed in the backup as UNINSTALL, and if the deployment contains an UNINSTALL routine this will be placed in the backup as INSTALL. So when the backup is installed (do you uninstall this deployment) it will run the PRE^UNINSTALL routine of the original deployment and after it is uninstalled it will run ^UNINSTALL. If transaction is false then we will not use a transaction to allow rolling back the install. If validatesig is true we will validate any code being replaced is the original version installed from InterSystems.

◆ LockItem()

_.Library.Status LockItem	(	_.Library.String	name,
		_.Library.Boolean	lock
	)

static

Lock a project with the name.

If lock is true then it is locked

and if it is false then it is unlocked.

◆ RemoveAllBreakPoints()

_.Library.Status RemoveAllBreakPoints ( )

Remove all break points from a project.

◆ RemoveAllWatchPoints()

_.Library.Status RemoveAllWatchPoints ( )

Remove all break points from a project.

◆ RemoveAllWatchVariables()

_.Library.Status RemoveAllWatchVariables ( )

Remove all watch variables from a project.

◆ SetStreamName()

_.Library.Status SetStreamName ( _.Library.String file )

This will try and set the <property>Stream</property> to point to the filename file.

This is used by the Studio so the Import method shows the filename the user expects.

◆ realCompile()

_.Library.Status realCompile	(		qstruct,
			_,
		_.Library.String	errorlog,
		_.Library.String	itemlist,
		_.Library.String	updatedlist
	)

static

Compile all the items in itemlist.

Used by <method>Compile</method> and <Method>Import</Method>.

Member Data Documentation

◆ SQLPUBLICSECURITY

SQLPUBLICSECURITY = None

static

Represents a Studio Project.

Many methods in this class use the qspec argument, which is a list of flags or qualifiers. See System Flags and Qualifiers.

◆ BreakPoints

BreakPoints

◆ DebugStepping

DebugStepping

◆ Defines

Defines

◆ Description

Description

◆ HttpServer

HttpServer

◆ Items

Items

◆ LastModified

LastModified

◆ Locked

Locked

◆ Name

Name

◆ Projections

Projections

◆ RunInTerminal

RunInTerminal

◆ Stream

Stream

Temporary stream for passing information between InterSystems IRIS and client system.

◆ StreamName

StreamName

Temporary name of the stream.

◆ Target

Target

◆ TargetType

TargetType

◆ TerminalPassword

TerminalPassword

◆ TerminalPort

TerminalPort

◆ TerminalUsername

TerminalUsername

◆ WatchPoints

WatchPoints

◆ WatchVariables

WatchVariables

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Static Private Member Functions

Detailed Description

Member Function Documentation

◆ IsModified()

◆ ObjectModified()

◆ OnClose()

◆ OnDelete()

◆ OnOpen()

◆ AddItem()

◆ Compile()

◆ CreateClone()

◆ Deploy()

◆ DeployToFile()

◆ DeployToGbl()

◆ DeployToStream()

◆ Export()

◆ ExportCDLToStream()

◆ ExportList()

◆ ExportListToStream()

◆ ExportRtn()

◆ ExportRtnToStream()

◆ ExportToStream()

◆ FindInFiles()

◆ FindInFilesRegex()

◆ FindInProject()

◆ GetStreamName()

◆ Import()

◆ ImportFromStream()

◆ InstallFromFile()

◆ InstallFromGbl()

◆ LockItem()

◆ RemoveAllBreakPoints()

◆ RemoveAllWatchPoints()

◆ RemoveAllWatchVariables()

◆ SetStreamName()

◆ realCompile()

Member Data Documentation

◆ SQLPUBLICSECURITY

◆ BreakPoints

◆ DebugStepping

◆ Defines

◆ Description

◆ HttpServer

◆ Items

◆ LastModified

◆ Locked

◆ Name

◆ Projections

◆ RunInTerminal

◆ Stream

◆ StreamName

◆ Target

◆ TargetType

◆ TerminalPassword

◆ TerminalPort

◆ TerminalUsername

◆ WatchPoints

◆ WatchVariables