Templates for the SEDRIS DRM

7 Template application program interface (API)

7.1 Introduction

7.1.1 Topics

Table 7.1 lists the topics in this clause.

Table 7.1 — Topics

7 Template application program interface

7.1 Introduction

7.1.1 Topics

7.1.2 Description

7.2 Document conventions and notations

7.3 Template API data types

7.3.1 Overview

7.3.2 Use of abstract scripting language data types

7.3.3 Other data types

7.4 Template API functions

7.4.2 Overview
7.4.2 Record Type
7.4.3 TAFCreateTransmittal
7.4.4 TAFCreateTemplate
7.4.5 TAFCombineTemplates


7.4.6 TAFDeleteAllTemplates
7.4.7 TAFDeleteTemplate
7.4.8 TAFIsCombinable
7.4.9 TAFHasParentTemplate
7.4.10 TAFHasChildTemplate
7.4.11 TAFCountTemplates
7.4.12 TAFCountParentsOfTemplate
7.4.13 TAFCountChildernOfTemplate
7.4.14 TAFGetAllTemplateNames
7.4.15 TAFIsTransmittalModified
7.4.16 TAFIsTemplateModified
7.4.17 TAFIsTransmittalEditable
7.4.18 TAFIsTemplateEditable
7.4.19 TAFIsTransmittalValid
7.4.20 TAFIsTemplateValid
7.4.21 TAFGetChildrenOfTemplate
7.4.22 TAFGetParentsOfTemplate
7.4.23 TAFCloseTransmittal
7.4.24 TAFPrintTemplate
7.4.25 TAFPrintAllTemplate

  

7.1.2 Description

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.

7.2 Document conventions and notations

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

Parameter name

Parameter data type

parameter_i

Data_Type_For_Parameter_i

Input/output parameters

Parameter name

Parameter data type

parameter_io

Data_Type_For_Parameter_io

Output parameters

Parameter name

Parameter data type

parameter_o

Data_Type_For_Parameter_o

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.

7.3 Template API data types

7.3.1 Overview

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.

7.3.2 Use of abstract scripting language data types

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.

7.3.3 Other data types

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.

7.4 Template API functions

7.4.1 Overview

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.

7.4.2 Record Type

record Template{

            String    template_name;

            Template_Type    template_type;

};


record Transmittal{

            Template    template[*];
            Integer    template_count;
            Boolean    isModified;
            Boolean    isEditable;
            Boolean    isValid:
            String    name;

};

7.4.3 TAFCreateTransmittal

Table 7.3 — TAFCreateTransmittal

Property Description

Semantics

VOID TAFCreateTransmittal (String fileName, Handle transmittal, Status_Code status)

Input parameters

Parameter name

Parameter data type

fileName String
status Status_Code

Input/output parameters

Parameter name

Parameter data type

transmittal

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.4 TAFCreateTemplate

Table 7.4 — TAFCreateTemplate

Property Description

Semantics

 VOID TAFCreateTemplate (Handle transmittal, Handle template, Status_Code status)

Input parameters

Parameter name

Parameter data type

status Status_Code

Input/output parameters

Parameter name

Parameter data type

transmittal

Handle

template Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.5 TAFCombineTemplates

Table 7.5 — TAFCombineTemplates

Property Description

Semantics

VOID TAFCombineTemplates (Handle source_template, Handle target_template, Status_Code status)

Input parameters

Parameter name

Parameter data type

status Status_Code

Input/output parameters

Parameter name

Parameter data type

source_template Handle
target_template Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.6 TAFDeleteAllTemplates

Table 7.6 — TAFDeleteAllTemplates

Property Description

Semantics

VOID TAFDeleteAllTemplates (Handle transmittal, Status_Code status)

Input parameters

Parameter name

Parameter data type

status Status_Code

Input/output parameters

Parameter name

Parameter data type

transmittal Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.7 TAFDeleteTemplate

Table 7.7 — TAFDeleteTemplate

Property Description

Semantics

VOID TAFDeleteTemplate (Handle source_template, Handle target_template, Status_Code status)

Input parameters

Parameter name

Parameter data type

status Status_Code

Input/output parameters

Parameter name

Parameter data type

source_template Handle
target_template Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.8 TAFIsCombinable

Table 7.8 — TAFIsCombinable

Property Description

Semantics

Boolean TAFIsCombinable (Handle source_template, Handle target_template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

source_template Handle
target_template Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.9 TAFHasParentTemplate

Table 7.3 — TAFHasParentTemplate

Property Description

Semantics

Boolean TAFHasParentTemplate (Handle target_template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

target_template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.10 TAFHasChildTemplate

Table 7.10 — TAFHasChildTemplate

Property Description

Semantics

Boolean TAFHasChildTemplate (Handle target_template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

target_template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.11 TAFCountTemplates

Table 7.11 — TAFCountTemplates

Property Description

Semantics

Integer TAFCountTemplates (Handle transmittal)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

transmittal

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.12 TAFCountParentsOfTemplate

Table 7.3 — TAFCountParentsOfTemplate

Property Description

Semantics

Integer TAFCountParentsOfTemplate (Handle target_template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

target_template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.13 TAFCountChildrenOfTemplate

Table 7.13 — TAFCountChildrenOfTemplate

Property Description

Semantics

Integer TAFCountChildrenOfTemplate (Handle target_template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

target_template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.14 TAFGetAllTemplateNames

Table 7.14 — TAFGetAllTemplateNames

Property Description

Semantics

String[] TAFGetAllTemplateNames (Handle transmittal)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

transmittal

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.15 TAFIsTransmittalModified

Table 7.15 — TAFIsTransmittalModified

Property Description

Semantics

Boolean TAFIsTransmittalModified (Handle transmittal)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

transmittal

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.16 TAFIsTemplateModified

Table 7.16 — TAFIsTemplateModified

Property Description

Semantics

Boolean TAFIsTemplateModified (Handle template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.17 TAFIsTransmittalEditable

Table 7.17 — TAFIsTransmittalEditable

Property Description

Semantics

Boolean TAFIsTransmittalEditable (Handle transmittal)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

transmittal

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.18 TAFIsTemplateEditable

Table 7.18 — TAFIsTemplateEditable

Property Description

Semantics

Boolean TAFIsTemplateEditable (Handle template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.19 TAFIsTransmittalValid

Table 7.19 — TAFIsTransmittalValid

Property Description

Semantics

Boolean TAFIsTransmittalValid (Handle transmittal)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

transmittal

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.20 TAFIsTemplateValid

Table 7.20 — TAFIsTemplateValid

Property Description

Semantics

Boolean TAFIsTemplateValid (Handle template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.21 TAFGetChildrenOfTemplate

Table 7.21 — TAFGetChildrenOfTemplate

Property Description

Semantics

Handle[] TAFGetChildrenOfTemplate (Handle target_template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

target_template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.22 TAFGetParentsOfTemplate

Table 7.22 — TAFGetParentsOfTemplate

Property Description

Semantics

Handle[] TAFGetParentsOfTemplate (Handle target_template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

target_template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.23 TAFCloseTransmittal

Table 7.23 — TAFCloseTransmittal

Property Description

Semantics

VOID TAFCloseTransmittal (Handle transmittal)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

transmittal

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.24 TAFPrintTemplate

Table 7.3 — TAFPrintTemplate

Property Description

Semantics

VOID TAFPrintTemplate (Handle target_template)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

target_template

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 


7.4.25 TAFPrintAllTemplates

Table 7.25 — TAFPrintAllTemplates

Property Description

Semantics

VOID TAFPrintAllTemplates (Handle transmittal)

Input parameters

Parameter name

Parameter data type

None  

Input/output parameters

Parameter name

Parameter data type

transmittal

Handle

Output parameters

Parameter name

Parameter data type

None

 

Success status codes

 

Failure status codes

 

 

http://standards.iso.org/ittf/PubliclyAvailableStandards/ISO_IEC_TR_24788_Ed1.html