%Document.Object

This callback method is invoked by the %New() 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.

Write the document as JSON to a stream.

Inherited description: This method validates an object. The %Save method of a persistent class calls it before filing any objects in the database. The %ValidateObject method of a referencing object can call it. You can also call it explicitly at any time.

%ValidateObject() does the following:

1. It tests if any required property values are missing.
2. If the PROPERTYVALIDATION class parameter is set to ValidateOnSave, it validates each non-null property value by calling the property method IsValid on each literal property and the object's %ValidateObject method for object-valued properties.
3. If present, it will call a user-supplied %OnValidateObject() method.

If any of these tests fail, %ValidateObject() immediately returns an error value. It is up to the caller of %ValidateObject to process the error value.

unused is not used. checkserial will force the checking of any serial properties by calling their %ValidateObject methods after swizzling this property.

Returns a %Status value indicating success or failure.

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

Returns a %Status value indicating success or failure.

Clears the contents of the array.

Returns a %Status value indicating success or failure.

Returns the number of elements contained in the array.

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.

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.

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.

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.

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.

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

Returns a %Status value indicating success or failure.

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 <= key <= Count() + 1
 

Returns a %Status value indicating success or failure.

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

Returns a %Status value indicating success or failure.

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 %Status value indicating success or failure.

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

Converts the serial state of this array object to a delimited string using the value of the ODBCDELIMITER parameter as a delimiter.

Converts the value of an incoming delimited string to a serialized state using the value of the ODBCDELIMITER parameter as a delimiter.

Finds and returns the key value of the element at the location preceding key in the array. If key is a null string (""), then Next() returns the key value for the last element in the array.

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.

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

Returns a %Status value indicating success or failure.

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

deswizzle serializes a %Document object into CSON format.

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

Display the current object and all nested objects.

swizzle converts a CSON object value into the current object.