API browser of generalFormRequest450 COM module


/images/arrow_right.png IForms interface V4.50/ 2 Sep 2016 
The IForms interface serves 2 purposes:
  1. The IForms::Search method searches and the iterator pair IForms::GetFirstObject / IForms::GetNextObject retrieve the found form space records. The form space is a hierarchical tree structure consisting of descriptive nodes. Each node in turn can hold other descriptive nodes and PDF form template files. Thus the form space is a concept to group the PDF forms inside a logical, hierarchical structure.
     
    Each node and leaf of the form space is described by a mandatory medForms OID, a name, a Boolean value if it is a node or a leaf, and an optional UID, where UID stands for the unique company specific ID assigned by the Federal Statistical Office. The given OID always stems from the medForms OID space and is supplied in its shortened form e.g. medforms.20.30.5050, where «medforms» is the abbreviation for the medForms base OID
     
  2. The IForms::StartUpdate method allows to check if the automatic background update process is running correctly or if e.g. the local firewall system is blocking the outbound update communication. Thus, StartUpdate is a surrogate to inform/pushing back problems and errors in the form update process.
space
space
/images/arrow_right.png Methods 8 methods
GetAbortInfo Get the abort information string with the error coded in the module language
GetFirstObject Retrieves the first form space record
GetNextObject Retrieves the next form space record
GetObjectInfo The GetObjectInfo method returns information about a given a medForms OID either in its full or shortened form.
GetObjects Method for collecting all object data covered by the IForms interface and returned as JSON array
Search The Search method allows to search the form space by using a combination of search criteria
StartUpdate With the change to an automatic, concurrent and externally running update process this method became a NOOP method except for the returned status
UpdateStatus With the change to an automatic, concurrent and externally running update process this method became a NOOP method
space
/images/arrow_right.png Properties 1 properties
[put] DestructForms Destructs/invalidates this IForms interface instance
 
space