format_message API method                                                               latest update: 2008-02-24

The format_message API method:

  1. generates an ISO 15926-7 compliant message to template type &oim:ST-MESSAGE-0100-001, that includes one or more ISO 15926-7 compliant documents:
    1. collects, starting with the ID of a given document instance, its describing template of the type &oim:ST-DOCUMENT-0098-001;
    2. then collects all instances of template type &oim:ST-DOCUMENT_PART-0097-001 that has a property 'isDocPartOf' that have the document ID, given in step a, as its rdf:object;
    3. then collects all instances of template type &oim:ST-DOCUMENT_PART-0097-001 that has a property 'isDocPartOf' that have one of the  document part IDs, found in step b, as its rdf:object;
    4. then collects all instances of template type &oim:ST-DOCUMENT_PART-0097-001 that has a property 'isDocPartOf' that have one of the  document part IDs, found in step c, as its rdf:object; etc.
    5. repeats this loop until no more template instances are found;
    6. then collects all instances of template type &oim:ST-DOCUMENT_CELL-0096-001 that has a property 'isDocCellOf' that have the document ID, given in step a, as its rdf:object;
    7. then collects all instances of template type &oim:ST-DOCUMENT_CELL-0096-001 that has a property 'isDocCellOf' that have one of the  document part IDs, found in steps b ,c, and up, as its rdf:object;
    8. collects the template instances that are the rdf:object of the 'hasAsInfo' property of all instances of template type &oim:ST-DOCUMENT_CELL-0096-001 found in steps f and g, and that were valid at the date-time that is the rdf:object of the 'isValidAt' property of the instance of the template type &oim:ST-DOCUMENT-0098-001, found in step a;
  2. stores this message with all document data in the "sentmsgs" section of the sending façade;
  3. invokes the gendoc method;
  4. creates a "feedback" report, refers to this in an instance of template oim:ST-FACADE-2311-001, and stores this in the "sentmsgs" section (NOTE).

NOTE - In the just-created instance of template type &oim:ST-MESSAGE-0100-001, as stored in the "sentmsgs" section of the sending façade, there is an instance of Activity listed. That is the transmitting activity. This "feedback" report is "involved_by_reference" in this activity. Generic template class ST-2311 represents involvement by reference in an activity.