Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Current »


 
SYNTAX:
 
xpxDefineMethodSignature (methodType, methodName  : STRING;                           schemaName, methodClass : STRING;                           argumentNames           : LIST OF STRING;                           argumentDataTypes       : LIST OF INTEGER;                           description             : STRING)                           status                  : INTEGER;
 
To be completed.
 
The xpxDefineMethodSignature function provides additional information / documentation of methods in the EDMdatabase.
The purpose of the user defined method signatures is to provide information about the methods and their input parameters to the users. The methods in question are Express-X mapping schemas and query functions. Query functions already have their input parameters stored in the dictionary model. Therefore, this function si not applicable for query function methods. However, there is no accompanying information that describes each input parameter nor the purpose of the method it self. Use xpxModifyMethodSignature to add this information. For mapping schemas, there is no information about the required input parameters in the dictionary model at all. By manually adding this information, users may find the required documentation of the methods within the EDMdatabase
One mapping schema may be used for many methods. I.e, they may all be based on the same piece of Express-X code, but the behaviour may depend on the input parameter signature given.
The arguments for the function are:

Argument:

Description:

methodType

Specify type of method, XPX or QEX

methodName

Specify name of method

schemaName

SchemaMap, ExpressSchema.QuerySchema

methodClass

optional: Examples: ifc_checkin, ifc_checkout, ifc_heal

argumentNames

NULL terminated list of argument names

argumentDataTypes

List of parameter data types

description

Optional. User added information/documentation, explaining the purpose of the method

 
This function is equivalent to the EDMinterface function edmiDefineMethodSignature.

  • No labels