OScript API/Built-in Package Index

Class: DAPINODE

DAPINODE is the object handle of a node stored in the DAPI database. It is used in the DAPI functions for all node manipulation operations.

The attributes of a node can be pre-assigned before creation using the DAPI.AllocNode and DAPI.CreateNode functions. The attributes of a node stored in the database are retrieved with the oft-used DAPI.GetNodeByID function. Note that all nodes have unique IDs.

The DAPI package provides automatic security checking when certain operations are performed on a node retrieved by a user. For example, an
error occurs when a user tries to delete a node that does not have delete permissions.

Instance Attributes

The ID of the user who is involved in any assignment.

The time interval value before the cache is expired.

The catalog representation flag.

Unused.

The number of children nodes.

The comment field in the user's preferred language.

The creation date and time of this node.

The ID of the user who created this node.

The assignment date and time.

The completion date and time.

The due date and time.

The effective date and time.

The expiration date and time.

The start date and time.

The delete status of this node.

A string field which is reserved for internal use.

A string field which is reserved for internal use.

The long text storage for binary data.

The external system creation date.

ID of the entity that created the item externally.

The external system modification date.

ID of the external source for this item.

The relative path to the gif file which is the custom icon of this node.

The ID of the group who is the group owner of the node.

The group access permission bit mask.

Globally unique identifier(GUID) for this node

The unique ID.

The major release number.

The maximum number of versions that this node can contain.

The minor release number.

The ID of the user who last modified this node.

The modification date and time of this node.

A RecArray containing the multilingual data for this node

The name of the node in the user's preferred language.

The ordering position number of a compound document child node.

The ID of the original node.

The volume ID of the original node.

The ID of the parent node.

The ID of the node which controls the permissions of this node.

The priority of the node.

The link type of a compound document alias.

An integer indicating reserved status.

The ID of the user who is reserving this node.

The date and time when the node is reserved.

The status of the node.

The unique type of this node.

The system access permission bit mask.

The subtype of the original node.

The ID of the user who is the owner of the node.

The user access permission bit mask.

The current version number.

The volume ID.

The world access permission bit mask.

Instance Attributes

Integer pAssignedTo

The ID of the user who is involved in the assignment. The column in the DTreeCore table is AssignedTo.

The time interval value before the cache is expired. It is used by the remote client. The column in the DTreeCore table is CacheExpiration.

Integer pCatalog

The catalog representation. The column in the DTreeCore table is Catalog.

String pCategory

Unused. The column in the DTreeCore table is DCategory.

Integer pChildCount

The number of children nodes. The column in the DTreeCore table is ChildCount.

String pComment

The comment field. In a multilingual system, the value will be in the user's preferred language (if available).

The creation date and time of this node. The column in the DTreeCore table is CreateDate.

Integer pCreatedBy

The ID of the user who created this node. The column in the DTreeCore table is CreatedBy.

The assignment date and time. The column in the DTreeCore table is DateAssigned.

The completion date and time. The column in the DTreeCore table is DateCompleted.

Date pDateDue

The due date and time. The column in the DTreeCore table is DateDue.

The effective date and time. The column in the DTreeCore table is DateEffective.

The expiration date and time. The column in the DTreeCore table is DateExpiration.

The start date and time. The column in the DTreeCore table is DateStarted.

Integer pDeleted

The delete status. Any non-zero value means that the node has been deleted logically. The column in the DTreeCore table is Deleted.

A string field which is reserved for internal use. The column in the DTreeCore table is ExAtt1.

A string field which is reserved for internal use. The column in the DTreeCore table is ExAtt2.

The long text storage for binary data. The column in the DTreeCore table is ExtendedData.

If available, this is the original creation date and time for the item in an external system. The column in the DTreeCoreExternalData table is ExternalCreateDate.

If available, this is the ID of the entity that created the item in an external system. The column in the DTreeCoreExternalData table is ExternalCreatorID.

If available, this is the modification date and time for the item in an external system. The column in the DTreeCoreExternalData table is ExternalModifyDate.

If available, this is the ID of the external system where this item originated. The column in the DTreeCoreExternalData table is ExternalSourceID.

String pGIF

The relative path to the gif file which is the custom icon of this node. The column in the DTreeCore table is GIF.

Integer pGroupID

The ID of the group who is the group owner of the node. The column in the DTreeCore table is GroupID.

Integer pGroupPerm

The group access permission bit mask. The column in the DTreeCore table is GPermissions.

GUID pGUID

Globally unique ientifier(GUID). The column in the DTreeCore table is GUID.

Integer pID

The unique ID. The column in the DTreeCore table is DataID.

Integer pMajor

The major release number. The column in the DTreeCore table is Major.

Integer pMaxVersion

The maximum number of versions that this node can contain. The column in the DTreeCore table is MaxVers.

Integer pMinor

The minor release number. The column in the DTreeCore table is Minor.

Integer pModifiedBy

The ID of the user who last modified this node. The column in the DTreeCore table is ModifiedBy.

The modification date and time of this node. The column in the DTreeCore table is ModifyDate.

RecArray pMultilingual

A RecArray containing the multilingual data for this node. This data is stored in the DTreeCoreMultilingual table.

String pName

The name field. In a multilingual system, the value will be in the user's preferred language (if available).

Integer pOrdering

The ordering position number of a compound document child node. The column in the DTreeCore table is Ordering.

Integer pOriginalID

If this node is a reference, then the value will be the ID of the original node that is referenced. The column in the DTreeCore table is OriginDataID.

If this node is a reference, then the value will be the volume ID of the original node that is referenced. The column in the DTreeCore table is OriginOwnerID.

Integer pParentID

The ID of the parent node. The column in the DTreeCore table is ParentID.

Integer pPermID

The ID of the node which controls the permissions of this node. The column in the DTreeCore table is PermID.

Integer pPriority

The priority of the node. The column in the DTreeCore table is Priority.

The link type of a compound document alias. The column in the DTreeCore table is ReleaseRef.

Integer pReserved

An integer indicating reserved status. The column in the DTreeCore table is Reserved.

Integer pReservedBy

The ID of the user who is reserving this node. The column in the DTreeCore table is ReservedBy.

The date and time when the node is reserved. The column in the DTreeCore table is ReservedDate.

The status of the node. The column in the DTreeCore table is Status.

Integer pSubType

The unique type of this node. The column in the DTreeCore table is SubType.

Integer pSystemPerm

The system access permission bit mask. The column in the DTreeCore table is SPermissions.

Integer pType

If this node is a reference, then the value will be the subtype of the original node that is referenced. The column in the DTreeCore table is DataType.

Integer pUserID

The ID of the user who is the owner of the node. The column in the DTreeCore table is UserID.

Integer pUserPerm

The user access permission bit mask. The column in the DTreeCore table is UPermissions.

Integer pVersionNum

The current version number. The column in the DTreeCore table is VersionNum.

Integer pVolumeID

The volume ID. The column in the DTreeCore table is OwnerID.

Integer pWorldPerm

The world access permission bit mask. The column in the DTreeCore table is WPermissions.

 Copyright © 2022 OpenText Corporation. All rights reserved.