Inheritance diagram for General:

[legend]

Collaboration diagram for General:

[legend]

Static Public Member Functions
	AccessibleNamespaces (_.Library.String pList)
	This method returns a list of accessible namespaces.

_.Library.Status	Base64FromStream (_.Library.Stream pStream, _.Library.Stream pEncoded)
	Encode a stream as BASE64.

_.Library.Status	BeginCaptureOutput (_.Library.String pCookie)
	This method starts capturing the output from a program.

_.Library.Status	CalcHash (_.Library.String pTextArray, pHash)
	Given an array of normalized text lines, compute the textual hash value.

_.Atelier.v1.Utils.LazyCollection	CreateDocumentCollection (pArray)
	Create a document collection object from an array of document objects.

_.Library.Status	CreateDocumentObject (_.Library.DynamicObject pDocObject, pDocArray, _.Library.String pName, _.Library.Status pDocStatus, _.Library.String pTimeStamp, _.Library.Boolean pUpToDate)
	Create a document object.

_.Library.Status	EndCaptureOutput (_.Library.String pCookie, _.Library.DynamicArray pText)
	This method retrieves the captured output and delivers it as an array of lines.

_.Library.Boolean	ExistsDoc (_.Library.String pDocName, pStatus)
	ExistsDoc checks that the item named by pDocName exists and returns More...

_.Library.Status	GetCSPAppPath (_.Library.String pName, pPath)
	This method returns the path for the named CSP application.

_.Library.String	GetCSPToken (_.Library.String pPage, _.Library.String pToken)
	For use via the Query API (/:namespace/action/query): More...

_.Library.Status	GetDbForDoc (_.Library.String pDocName, pDatabase)
	Given the name of a class, return the database to which it is mapped.

_.Library.Status	GetDbdirCrhash (_.Library.String pDbdir, _.Library.String pHash)
	Given the database directory definition, get the creation time hash value.

_.Library.Status	GetDocCategory (_.Library.String pDocName, _.Library.String pCategory)
	Given a document name, return the category. More...

_.Library.Status	GetDocHash (_.Library.String pName, _.Library.String pHash, _.Library.String pTextArray)
	This method takes a document name and computes a hash value. More...

_.Library.Status	GetModifiedDocuments (pHashes, _.Library.String pType, _.Library.String pGbl, _.Library.Boolean pShowGenerated)
	Given an array of hashes which represent databases, and using the database mappings for the. More...

_.Library.Status	GetModifiedDocumentsDB (_.Library.String pDatabase, _.Library.String pHash, _.Library.String pType, _.Library.String pDocs, _.Library.Boolean pShowGenerated)
	Given a database name and a hash value, return a list of documents of the requested type which have been modified. More...

	GetNameFromDocArray (pTextArray, pName)
	This method parses a document header and extracts the name.

_.Library.Status	GetRoutineMappings (rtndir)
	Get the routine mappings and break them out into. More...

_.Library.String	Hash (_.Library.String pValue)
	Compute a hash value but replace potentially problematic characters.

_.Library.Status	NamespaceDbList (_.Library.String pNamespace, _.Library.String pDB)
	Return list of databases where the routines for a namespace are mapped. More...

_.Library.String	NormalizeDocName (_.Library.String pDocName)
	NormalizeDocName adds the default package name to .cls files. More...

_.Library.String	TS (pDocName, pUpToDate)
	Return a normalized timestamp for a document.

_.Library.String	ValidLANG (_.Library.String pMode, _.Library.String pKeywords)
	ValidLANG(pMode,pKeyword) checks that a LanguageMode attribute More...

_.Library.String	ValidType (_.Library.String pType, _.Library.String pKeywords)
	ValidType(pType,pKeyword) checks that a Type attribute is valid. More...

_.Library.Boolean	ValidateDocName (_.Library.String pDocName, pStatus, _.Library.String pCategory, _.Library.Boolean pBinary)
	ValidateDocName tests that a DocName has legal syntax More...

_.Library.Status	WrapRtnDocWithXML (_.Library.String pDocumentArray, _.Library.Stream pWrappedDocument)
	This method wraps a client document with an XML wrapper which allows it to be imported into InterSystems IRIS.

	WriteMsg (_.Library.String pMsgArray)
	Output a message array.

Additional Inherited Members
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	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. 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 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...

Member Function Documentation

◆ ExistsDoc()

_.Library.Boolean ExistsDoc	(	_.Library.String	pDocName,
			pStatus
	)

static

ExistsDoc checks that the item named by pDocName exists and returns

the appropriate <class>Boolean</class> value.

◆ GetCSPToken()

_.Library.String GetCSPToken	(	_.Library.String	pPage,
		_.Library.String	pToken
	)

static

For use via the Query API (/:namespace/action/query):

Returns a token for use in CSPCHD in a URL May validate and extend an existing token (pToken)

◆ GetDocCategory()

_.Library.Status GetDocCategory	(	_.Library.String	pDocName,
		_.Library.String	pCategory
	)

static

Given a document name, return the category.

The <class>Status</class> value is from <method>ValidateDocName</method>.

◆ GetDocHash()

_.Library.Status GetDocHash	(	_.Library.String	pName,
		_.Library.String	pHash,
		_.Library.String	pTextArray
	)

static

This method takes a document name and computes a hash value.

by applying the sha1 hash function to normalized source

◆ GetModifiedDocuments()

_.Library.Status GetModifiedDocuments	(		pHashes,
		_.Library.String	pType,
		_.Library.String	pGbl,
		_.Library.Boolean	pShowGenerated
	)

static

Given an array of hashes which represent databases, and using the database mappings for the.

current namespace, return a list of documents of the requested type which have been modified after the given hash was generated. The list is in the returned process private global.

◆ GetModifiedDocumentsDB()

_.Library.Status GetModifiedDocumentsDB	(	_.Library.String	pDatabase,
		_.Library.String	pHash,
		_.Library.String	pType,
		_.Library.String	pDocs,
		_.Library.Boolean	pShowGenerated
	)

static

Given a database name and a hash value, return a list of documents of the requested type which have been modified.

after the given hash was generated. The current hash value will be returned in the pHash argument.

◆ GetRoutineMappings()

_.Library.Status GetRoutineMappings ( rtndir )

static

Get the routine mappings and break them out into.

lists for each routine type

◆ NamespaceDbList()

_.Library.Status NamespaceDbList	(	_.Library.String	pNamespace,
		_.Library.String	pDB
	)

static

Return list of databases where the routines for a namespace are mapped.

It does not include the default database.

◆ NormalizeDocName()

_.Library.String NormalizeDocName ( _.Library.String pDocName )

static

NormalizeDocName adds the default package name to .cls files.

It also

down cases the DocName type for class and routine types.

The pDocName is assumed to have been validated by ..<method>ValidateDocName</method>.

Returns the normalized DocName as a <class>String</class>.

◆ ValidLANG()

_.Library.String ValidLANG	(	_.Library.String	pMode,
		_.Library.String	pKeywords
	)

static

ValidLANG(pMode,pKeyword) checks that a LanguageMode attribute

is valid. If the mode is valid then it is inserted into the pKeywords array (passed by reference) and returned as the result of ValidLANG

If the mode is invalid then ValidLANG returns "".

Note: If the pKeywords array contains a conflicting Type value or a conflicting LanguageMode value then the mode attribute is invalid.

◆ ValidType()

_.Library.String ValidType	(	_.Library.String	pType,
		_.Library.String	pKeywords
	)

static

ValidType(pType,pKeyword) checks that a Type attribute is valid.

If the type is valid then it is changed to upper case, inserted into the pKeywords array (passsed by reference) and returned as the result of ValidType

If the type is invalid then ValidType returns "".

Note: If the pKeywords array contains a conflicting Type value or a conflicting LanguageMode value then the Type attribute is invalid.

◆ ValidateDocName()

_.Library.Boolean ValidateDocName	(	_.Library.String	pDocName,
			pStatus,
		_.Library.String	pCategory,
		_.Library.Boolean	pBinary
	)

static

ValidateDocName tests that a DocName has legal syntax

Returns a <class>Boolean</class>:

1 - If pDocName has legal DocName syntax
0 - Otherwise

Also returns the Category of the document and a Boolean of whether the document needs to be transmitted as binary or not.

Static Public Member Functions

Additional Inherited Members

Member Function Documentation

◆ ExistsDoc()

◆ GetCSPToken()

◆ GetDocCategory()

◆ GetDocHash()

◆ GetModifiedDocuments()

◆ GetModifiedDocumentsDB()

◆ GetRoutineMappings()

◆ NamespaceDbList()

◆ NormalizeDocName()

◆ ValidLANG()

◆ ValidType()

◆ ValidateDocName()