%Document.Object
serial class %Document.Object extends %Library.SerialObject, %XML.Adaptor
Method Inventory
- %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
This method validates an object.
The %Save() method of a persistent class calls this method before filing any objects in the database. The %ValidateObject() of a referencing object can call it. You can also call it explicitly at any time.
%ValidateObject() does the following:
- If present, it will call a user-supplied %OnValidateObject() method.
- It checks 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 %ValidateObject method for each object-valued embedded object property (properties whose type extend %SerialObject).
- If checkserial is 1, it forces the checking of any embedded object properties by calling their %ValidateObject method after swizzling this property.
- If checkserial is 2, it forces the checking of any collections of serial types by iterating over those collections and calling their %ValidateObject() method after swizzling this property, in addition to the validation that occurs when checkserial is 1.
%ValidateObject() returns a %Status indicating success or error. It is up to the caller to process the error value.
%ValidateObject() does not validate object-valued reference properties (properties whose type extends %Persistent) due to the possibility of circular dependencies between objects. The %Save() method of a persistent class automatically detects and handles circular references between objects. If you require the validation of reference properties, you can override this method in a subclass or call %Save() directly.
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
- %AddToSaveSet()
- %AddToSyncSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %Delete()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %Extends()
- %GetParameter()
- %GetSwizzleObject()
- %IsA()
- %IsModified()
- %IsNull()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %OnBeforeAddToSync()
- %OnDetermineClass()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %ResolveConcurrencyConflict()
- %SerializeObject()
- %SetModified()
- %SyncObjectIn()
- %SyncTransport()
- XMLDTD()
- XMLExport()
- XMLExportToStream()
- XMLExportToString()
- XMLNew()
- XMLSchema()
- XMLSchemaNamespace()
- XMLSchemaType()