Inheritance diagram for Object:

[legend]

Collaboration diagram for Object:

[legend]

Public Member Functions
_.Library.Status	OnNew (_.Library.String pObjectValue, _.Library.Integer pIsList)
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

_.Library.Status	Clear ()
	Clears the contents of the array. More...

_.Library.Integer	Count ()
	Returns the number of elements contained in the array.

_.Library.String	Find (_.Library.String element, _.Library.String key)
	Starting from, but not including, location key,. More...

_.Library.String	GetAt (_.Library.String key)
	Finds and returns the value of the element at position. More...

_.Library.String	GetNext (_.Library.String key)
	Finds and returns the value of the element at the location after key More...

_.Library.String	GetPrevious (_.Library.String key)
	Finds and returns the value of the element at the location before key More...

_.Library.Status	Insert (_.Library.RawString element)
	Inserts an element with value element at the end of the list. More...

_.Library.Status	InsertAt (_.Library.RawString element, _.Library.Integer key)
	Inserts an element with value element at position key. More...

_.Library.Status	InsertList (_.Library.RawString inslist)
	Inserts a list with value inslist at the end of the list. More...

_.Library.Status	InsertOrdered (_.Library.RawString element)
	Inserts an element with value element into the list at the correct ordered. More...

_.Library.Boolean	IsDefined (_.Library.String key)
	Returns true (1) if a value is defined at location key,. More...

_.Library.String	Previous (_.Library.String key)
	Finds and returns the key value of the element at the location preceding key in the array. More...

_.Library.RawString	RemoveAt (_.Library.Integer key)
	Removes the element at position key in the list. More...

_.Library.Status	SetAt (_.Library.RawString element, _.Library.Integer key)
	Sets the value of the element at position key to element. More...

_.Library.String	deswizzle ()
	deswizzle serializes a Document object into CSON format.

_.Library.Status	save (_.ZEN.Datatype.string pWhere, _.ZEN.Datatype.string pDocumentID, _.Library.Integer pUpdate)
	Save the Document to a global or local variable reference (GLVN) with the specified pDocumentID. More...

	show (_.ZEN.Datatype.integer pLevel)
	Display the current object and all nested objects.

	swizzle (_.Library.String pObjectValue)
	swizzle converts a CSON object value into the current object.

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	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...

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	BuildValueArray (_.Library.Binary serialized, _.Library.Binary array)
	Constructs array(key)=value for each element in the serialval value. More...

_.ZEN.Datatype.boolean	DocumentExists (_.ZEN.Datatype.string pWhere, _.ZEN.Datatype.string pDocumentID)
	DocumentExists() returns a boolean value indicate whether or not the documentID exists in the global/local variable reference (GLVN). More...

_.Library.String	LogicalToOdbc (_.Library.String val)
	Converts the serial state of this array object to a delimited string. More...

_.Library.String	OdbcToLogical (_.Library.String val)
	Converts the value of an incoming delimited string to a serialized state. More...

_.Document.Object	XML (_.Library.Binary pXML)
	Document.Object contructor that populates the document content from an XML source. More...

_.Document.Object	open (_.ZEN.Datatype.string pWhere, _.ZEN.Datatype.string pDocumentID, _.Library.Status pStatus)
	OpenDocument will retrieve a previously saved document from the specified global or local variable reference (GLVN) with the specified pDocumentID More...

Static Public Member Functions inherited from SerialObject
_.Library.String	LogicalToOdbc (_.Library.String val)
	Converts the serial state of this serial object to a delimited string. More...

_.Library.String	OdbcToLogical (_.Library.String val)
	Converts the value of an incoming delimited string to a serialized state. 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...

Private Member Functions
_.Library.Status	ToJSONStream (_.Stream.Object pStream, _.Library.Boolean pRewindStream)
	Write the document as JSON to a stream.

Additional Inherited Members
Static Public Attributes inherited from SerialObject
	ODBCDELIMITER = None
	A serial object is converted to a delimited string containing the. More...

	SERIALDELIMITER = None
	This parameter specifies the delimiter character used when created a serialized. More...

	VALIDIFNULL = None
	If true, ValidateObject will return $$$OK for instances that are null as determined by IsNull(). 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...

Member Function Documentation

◆ OnNew()

_.Library.Status OnNew	(	_.Library.String	pObjectValue,
		_.Library.Integer	pIsList
	)

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

provide notification that a new instance of an object is being created.

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

It is passed the arguments provided in the New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from New(). For example, if you're going to call New, passing 2 arguments, OnNew's signature could be:

Method OnNew(dob as Date = "", name as Name = "") as Status If instead of returning a Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of New method.

◆ BuildValueArray()

_.Library.Status BuildValueArray	(	_.Library.Binary	serialized,
		_.Library.Binary	array
	)

static

Constructs array(key)=value for each element in the serialval value.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

◆ Clear()

_.Library.Status Clear ( )

Clears the contents of the array.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

◆ DocumentExists()

_.ZEN.Datatype.boolean DocumentExists	(	_.ZEN.Datatype.string	pWhere,
		_.ZEN.Datatype.string	pDocumentID
	)

static

DocumentExists() returns a boolean value indicate whether or not the documentID exists in the global/local variable reference (GLVN).

Parameters

pWhere

Input

Global or local variable reference where documents are stored.

pDocumentID

Input

The document ID.

◆ Find()

_.Library.String Find	(	_.Library.String	element,
		_.Library.String	key
	)

Starting from, but not including, location key,.

finds the next element in the array with value equal to element.

If key is a null string (""), the search starts at the beginning of the array.

Find returns the key associated with the found element or null string ("") if no element is found.

◆ GetAt()

_.Library.String GetAt ( _.Library.String key )

Finds and returns the value of the element at position.

key in the list.

GetAt returns the value of the element at location key or null string ("") if no element is found.

◆ GetNext()

_.Library.String GetNext ( _.Library.String key )

Finds and returns the value of the element at the location after key

in the array. If key is a null string (""), it returns the value of the first element in the array.

The value of key, which is passed by reference, is updated to the key value of the returned element or null string ("") if key is at the end of the array.

◆ GetPrevious()

_.Library.String GetPrevious ( _.Library.String key )

Finds and returns the value of the element at the location before key

in the array. If key is a null string (""), it returns the value of the last element in the array.

The value of key, which is passed by reference, is updated to the key value of the returned element or null string ("") if key is at the beginning of the array.

◆ Insert()

_.Library.Status Insert ( _.Library.RawString element )

Inserts an element with value element at the end of the list.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

◆ InsertAt()

_.Library.Status InsertAt	(	_.Library.RawString	element,
		_.Library.Integer	key
	)

Inserts an element with value element at position key.

To make room for the new element, the elements previously at or following position key are moved up by one position.

key must be in the following range:

1 &lt= key &lt= Count() + 1

Returns a <CLASS>Status</CLASS> value indicating success or failure.

◆ InsertList()

_.Library.Status InsertList ( _.Library.RawString inslist )

Inserts a list with value inslist at the end of the list.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

◆ InsertOrdered()

_.Library.Status InsertOrdered ( _.Library.RawString element )

Inserts an element with value element into the list at the correct ordered.

position. The elements in the list are shifted to accommodate the new element as necessary.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

◆ IsDefined()

_.Library.Boolean IsDefined ( _.Library.String key )

Returns true (1) if a value is defined at location key,.

otherwise false (0).

◆ LogicalToOdbc()

_.Library.String LogicalToOdbc ( _.Library.String val )

static

Converts the serial state of this array object to a delimited string.

using the value of the ODBCDELIMITER parameter as a delimiter.

◆ OdbcToLogical()

_.Library.String OdbcToLogical ( _.Library.String val )

static

Converts the value of an incoming delimited string to a serialized state.

using the value of the ODBCDELIMITER parameter as a delimiter.

◆ Previous()

_.Library.String Previous ( _.Library.String key )

Finds and returns the key value of the element at the location preceding key in the array.

If key is a null string (""), then <METHOD>Next</METHOD> returns the key value for the last element in the array.

◆ RemoveAt()

_.Library.RawString RemoveAt ( _.Library.Integer key )

Removes the element at position key in the list.

The elements following position key are moved to fill in the resulting gap.

RemoveAt returns the value of the removed element or null string ("") if no element was removed.

◆ SetAt()

_.Library.Status SetAt	(	_.Library.RawString	element,
		_.Library.Integer	key
	)

Sets the value of the element at position key to element.

Returns a <CLASS>Status</CLASS> value indicating success or failure.

◆ XML()

_.Document.Object XML ( _.Library.Binary pXML )

static

Document.Object contructor that populates the document content from an XML source.

pXML can either be a counted array of lines, a stream object, or...

◆ open()

_.Document.Object open	(	_.ZEN.Datatype.string	pWhere,
		_.ZEN.Datatype.string	pDocumentID,
		_.Library.Status	pStatus
	)

static

OpenDocument will retrieve a previously saved document from the specified global or local variable reference (GLVN) with the specified pDocumentID

and return an oref referencing an instance of ZEN.proxyObject. If a document with the specified ID does not exist in that GLVN then OpenDocument will return an error in the output pStatus parameter.

Parameters

pWhere

Input

Global or local variable reference. This is the location where the proxyObject instance will be saved.

pDocumentID

Input

The ID of the document to be opened.

pStatus

Output

The returned Status value, indicating success or failure.

◆ save()

_.Library.Status save	(	_.ZEN.Datatype.string	pWhere,
		_.ZEN.Datatype.string	pDocumentID,
		_.Library.Integer	pUpdate
	)

Save the Document to a global or local variable reference (GLVN) with the specified pDocumentID.

If a document with the same ID already exists in that GLVN then an error Status value is returned.

Parameters

pWhere

Input

Global or local variable reference. This is the location where the Document instance will be saved.

pDocumentID

Input

The document ID. This value must be unique within the GLVN specified in pWhere.

Public Member Functions

Static Public Member Functions

Private Member Functions

Additional Inherited Members

Member Function Documentation

◆ OnNew()

◆ BuildValueArray()

◆ Clear()

◆ DocumentExists()

◆ Find()

◆ GetAt()

◆ GetNext()

◆ GetPrevious()

◆ Insert()

◆ InsertAt()

◆ InsertList()

◆ InsertOrdered()

◆ IsDefined()

◆ LogicalToOdbc()

◆ OdbcToLogical()

◆ Previous()

◆ RemoveAt()

◆ SetAt()

◆ XML()

◆ open()

◆ save()