%Document.Object
serial class %Document.Object extends %Library.SerialObject, %XML.Adaptor
Method Inventory (Including Private)
- %GetSerial()
- %OnNew()
- %SetSerial()
- %ToJSONStream()
- %ValidateObject()
- BuildValueArray()
- CSON()
- Clear()
- Count()
- DocumentExists()
- Find()
- GetAt()
- GetNext()
- GetPrevious()
- Insert()
- InsertAt()
- InsertList()
- InsertOrdered()
- IsDefined()
- LogicalToOdbc()
- Next()
- OdbcToLogical()
- Previous()
- RemoveAt()
- SetAt()
- XML()
- deswizzle()
- loadResultSet()
- loadXML()
- open()
- save()
- show()
- swizzle()
Methods (Including Private)
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.
%ValidateObject() does the following:
- It tests if any required property values are missing.
- 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.
- 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.
Returns a %Status value indicating success or failure.
Returns a %Status value indicating success or failure.
Parameters | ||
---|---|---|
pWhere | Input |
Global or local variable reference where documents are stored. |
pDocumentID | Input |
The document ID. |
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 returns the value of the element at location key or null string ("") if no element is found.
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.
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.
Returns a %Status value indicating success or failure.
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.Returns a %Status value indicating success or failure.
Returns a %Status value indicating success or failure.
RemoveAt returns the value of the removed element or null string ("") if no element was removed.
Returns a %Status value indicating success or failure.
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. |
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. |
Inherited Members
Inherited Methods (Including Private)
- %AddToSaveSet()
- %AddToSyncSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %ConstructCloneInit()
- %Delete()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %Extends()
- %GetParameter()
- %GetSwizzleObject()
- %IsA()
- %IsModified()
- %IsNull()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %OnAddToSaveSet()
- %OnBeforeAddToSync()
- %OnClose()
- %OnConstructClone()
- %OnDetermineClass()
- %OnJournalObject()
- %OnOpen()
- %OnValidateObject()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %SerializeObject()
- %SetModified()
- %SyncObjectIn()
- %SyncTransport()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLImportAttributes()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()