OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide

The GPI Library
OSI/MHS Gateway Programmatic Interface (GPI) Programming Guide—424822-001
2-5
Object Management Procedures
resolved into object structures that themselves are composed of other attributes. This
XAPIA concept is fully described in Section 3, GPI Object Management.
The four types of object management procedures are shown in Figure 2-3
. Procedures
from each type are typically used at different points in the program, as described in
following subsections.
GPI_OM_CREATE_ , GPI_OM_INSERT_ , and
GPI_OM_WRITE_
Composing procedures are listed in Table 2-3. They are generally used to build objects
during outbound processing. Building objects is a process of first creating an object,
then filling it with attributes. Small objects are built, then inserted into larger objects.
The goal of outbound processing is to create a root object that is functionally equivalent
to a message, probe, report, or P1-encoded object. Having done so, the client transfers
the root object out to the GPI service output queue.
Figure 2-3. GPI Program Flow: Object Management Procedures
Table 2-3. Object Management Composing Procedures
Procedure Name Purpose
GPI_OM_CREATE_ Creates a new object of a specified class
GPI_OM_INSERT_ Adds attributes to an object
GPI_OM_WRITE_ Writes a segment of a data string to a value of an attribute
203CDT .CDD
GPI Procedure
Open a session
Program Flow
Note: GPI_STATUS_ may
be used anytime after
successful GPI_INITIALIZE_
Initialize workspace
GPI_CLOSE_
Close a session
Object management
and
message transfer operations
GPI_OM_CREATE_
GPI_OM_INSERT_
GPI_OM_WRITE_
Composing:
GPI_OM_EXAMINE_
GPI_OM_FETCH_
GPI_OM_LIST_
Inspecting:
GPI_OM_READ_
GPI_OM_COPY_
Copying:
GPI_OM_DELETE_
GPI_OM_REMOVE_
Decomposing:
Message transfer: GPI_MT_xxx_
GPI_INITIALIZE_
GPI_OPEN_
GPI_CLOSE_