Table 7.1 lists the topics in this clause.
This clause provides a detailed definition of the syntax and semantics of each API function. The API provides the means for creating, accessing, and modifying transmittals.
The following convention is used to present information about the API. Table 7.2 itemizes the different properties of the API functions.
Table 7.2 — API presentation format
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
A specification of the operation of the function. |
||||
Input parameters |
|
||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
A list of success status codes that may apply when this function terminates. |
||||
Failure status codes |
A list of failure status codes that may apply when this function terminates. |
The parameters of the template API functions fundamentally use the same data types as are specified for the abstract scripting language. In 7.4 Template API functions, the data types specified in the various tables shall use the data types that are specified for the abstract scripting language.
Data types that are specified or can be defined as specified in 6.2.2 Available data types may be used as parameter data types in the Template API functions.
The data types of the abstract scripting language are designed to support most of the data types specified in ISO/IEC 18023-1. It is the responsibility of the application using the templates to map between those data types and the data types of the abstract scripting language.
The functions declared in this clause are used to create, modify, and access transmittals. There are also functions that interface with the error handling mechanism specified by the API.
record Template{
String template_name;
Template_Type template_type;
};
record Transmittal{
Template
template[*];
Integer
template_count;
Boolean
isModified;
Boolean
isEditable;
Boolean
isValid:
String
name;
};
Table 7.3 — TAFCreateTransmittal
Property | Description | ||||||
---|---|---|---|---|---|---|---|
Semantics |
VOID TAFCreateTransmittal (String fileName, Handle transmittal, Status_Code status) | ||||||
Input parameters |
| ||||||
Input/output parameters |
|
||||||
Output parameters |
|
||||||
Success status codes |
|
||||||
Failure status codes |
|
Table 7.4 — TAFCreateTemplate
Property | Description | ||||||
---|---|---|---|---|---|---|---|
Semantics |
VOID TAFCreateTemplate (Handle transmittal, Handle template, Status_Code status) | ||||||
Input parameters |
| ||||||
Input/output parameters |
|
||||||
Output parameters |
|
||||||
Success status codes |
|
||||||
Failure status codes |
Table 7.5 — TAFCombineTemplates
Property | Description | ||||||
---|---|---|---|---|---|---|---|
Semantics |
VOID TAFCombineTemplates (Handle source_template, Handle target_template, Status_Code status) | ||||||
Input parameters |
| ||||||
Input/output parameters |
|
||||||
Output parameters |
|
||||||
Success status codes |
|
||||||
Failure status codes |
Table 7.6 — TAFDeleteAllTemplates
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
VOID TAFDeleteAllTemplates (Handle transmittal, Status_Code status) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.7 — TAFDeleteTemplate
Property | Description | ||||||
---|---|---|---|---|---|---|---|
Semantics |
VOID TAFDeleteTemplate (Handle source_template, Handle target_template, Status_Code status) | ||||||
Input parameters |
| ||||||
Input/output parameters |
|
||||||
Output parameters |
|
||||||
Success status codes |
|
||||||
Failure status codes |
Table 7.8 — TAFIsCombinable
Property | Description | ||||||
---|---|---|---|---|---|---|---|
Semantics |
Boolean TAFIsCombinable (Handle source_template, Handle target_template) | ||||||
Input parameters |
| ||||||
Input/output parameters |
|
||||||
Output parameters |
|
||||||
Success status codes |
|
||||||
Failure status codes |
Table 7.3 — TAFHasParentTemplate
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Boolean TAFHasParentTemplate (Handle target_template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.10 — TAFHasChildTemplate
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Boolean TAFHasChildTemplate (Handle target_template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.11 — TAFCountTemplates
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Integer TAFCountTemplates (Handle transmittal) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.3 — TAFCountParentsOfTemplate
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Integer TAFCountParentsOfTemplate (Handle target_template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.13 — TAFCountChildrenOfTemplate
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Integer TAFCountChildrenOfTemplate (Handle target_template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.14 — TAFGetAllTemplateNames
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
String[] TAFGetAllTemplateNames (Handle transmittal) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.15 — TAFIsTransmittalModified
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Boolean TAFIsTransmittalModified (Handle transmittal) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.16 — TAFIsTemplateModified
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Boolean TAFIsTemplateModified (Handle template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.17 — TAFIsTransmittalEditable
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Boolean TAFIsTransmittalEditable (Handle transmittal) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.18 — TAFIsTemplateEditable
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Boolean TAFIsTemplateEditable (Handle template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.19 — TAFIsTransmittalValid
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Boolean TAFIsTransmittalValid (Handle transmittal) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.20 — TAFIsTemplateValid
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Boolean TAFIsTemplateValid (Handle template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.21 — TAFGetChildrenOfTemplate
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Handle[] TAFGetChildrenOfTemplate (Handle target_template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.22 — TAFGetParentsOfTemplate
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
Handle[] TAFGetParentsOfTemplate (Handle target_template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.23 — TAFCloseTransmittal
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
VOID TAFCloseTransmittal (Handle transmittal) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.3 — TAFPrintTemplate
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
VOID TAFPrintTemplate (Handle target_template) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
Table 7.25 — TAFPrintAllTemplates
Property | Description | ||||
---|---|---|---|---|---|
Semantics |
VOID TAFPrintAllTemplates (Handle transmittal) | ||||
Input parameters |
| ||||
Input/output parameters |
|
||||
Output parameters |
|
||||
Success status codes |
|
||||
Failure status codes |
http://standards.iso.org/ittf/PubliclyAvailableStandards/ISO_IEC_TR_24788_Ed1.html