Print Page as PDF
CALLS TO TIUSRVLI ICR (3441)

CALLS TO TIUSRVLI    ICR (3441)

Name Value
NUMBER 3441
IA # 3441
DATE CREATED 2001/08/16
CUSTODIAL PACKAGE TEXT INTEGRATION UTILITIES
CUSTODIAL ISC Salt Lake City
USAGE Controlled Subscription
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE TIUSRVLI
NAME CALLS TO TIUSRVLI
GENERAL DESCRIPTION
CPRS makes use of several APIs in TIUSRVLI to determine
the complete hierarchical context of a given document when building the
TreeView for the Notes, Summaries, and Consults tabs.
STATUS Active
DURATION Till Otherwise Agreed
ID TIUSRVLI
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT COMPONENT DESCRIPTION VARIABLES
$$HASDAD(DA)
Boolean extrinsic function which evaluates whether a
given document has a parent (i.e., either it is an addendum, or an
Interdisciplinary Entry).
VARIABLES TYPE VARIABLES DESCRIPTION
DA Input
This is the record number (IEN) of the document in
file 8925.
Output
The function returns TRUE (i.e., 1) if the document
has a parent (i.e., it's an addendum or an Interdisciplinary entry), or FALSE
(i.e., 0) if the document stands alone.
SETDAD(TIUY,DA,TIUI)
This subroutine will build an array which includes
the complete hierarchical "ancestry" of a given TIU Document. For example, if
one passes the record number of an addendum to an Interdisciplnary entry, and
the name of an array to be returned (either as $NA(^TMP("<namespace>",$J)) or
as a local array), the module will return the Interdisciplinary Parent entry,
and the Interdisciplinary entry to which the addendum belongs.

NOTE: Prior to making the call, the local variable SEQUENCE should be set,
indicating whether the documents should be returned in ascending ("A") or
descending ("D") chronological order. Default is descending (most recent
first).
VARIABLES TYPE VARIABLES DESCRIPTION
TIUY Input
This is the NAME of the array (global or local) in
which the data should be returned.
DA Input
This is the record number (IEN) of the document in
the TIU DOCUMENT FILE (#8925).
TIUI Input
This OPTIONAL parameter is the subscript from which
the array should be incremented (defaults to 1). This allows the calling
application to accumulate the ancestry of multiple documents in the same
array, by calling SETDAD iteratively.
$$HASKIDS(DA)
Boolean extrinsic function which evaluates whether a
given document has descendents (i.e., either addenda, or an Interdisciplinary
Entries).
VARIABLES TYPE VARIABLES DESCRIPTION
DA Input
This is the record number (IEN) of the document in
the TIU DOCUMENT FILE (#8925).
Output
The function returns TRUE (i.e., 1) if the document
has descendents (i.e., addenda or Interdisciplinary Entries), or FALSE (i.e.,
0) if the document has none.
SETKIDS(TIUY,DA,TIUI)
This subroutine will build an array which includes
all descendents of a given TIU Document. For example, if one passes the record
number of an Interdisciplinary parent document, which has one or more entries,
any of which having addenda; and the name of an array to be returned (either
as $NA(^TMP("<namespace>",$J)) or as a local array), the module will return
the complete hierarchy.

NOTE: Prior to making the call, the local variable SEQUENCE should be set,
indicating whether the documents should be returned in ascending ("A") or
descending ("D") chronological order. Default is descending (most recent
first).
VARIABLES TYPE VARIABLES DESCRIPTION
TIUY Input
This is the NAME of the array (global or local) in
which the data should be returned.
DA Input
This is the record number (IEN) of the document in
the TIU DOCUMENT FILE (#8925).
TIUI Input
This OPTIONAL parameter is the subscript from which
the array should be incremented (defaults to 1). This allows the calling
application to accumulate the ancestry of multiple documents in the same
array, by calling SETKIDS iteratively.
SUBSCRIBING PACKAGE
SUBSCRIBING PACKAGE ISC
ORDER ENTRY/RESULTS REPORTING Salt Lake City