xpxDefineMethodSignature

FUNCTION xpxDefineMethodSignature (methodType, methodName  : STRING;
                                   schemaName, methodClass : STRING;
                                   argumentNames           : LIST OF STRING; 
                                   argumentDataTypes       : LIST OF INTEGER;
                                   description             : STRING)   
                                   status                  : INTEGER;

This 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 behavior may depend on the input parameter signature given.                                  

 

Arguments


1TypeNameComment
2STRINGmethodTypeSpecify type of method, XPX or QEX
3STRINGmethodNameSpecify name of method
4STRINGschemaNameSchemaMap, ExpressSchema or QuerySchema name
5STRINGmethodClassoptional: Examples: ifc_checkin, ifc_checkout, ifc_heal
6LIST OF STRINGargumentNamesNULL terminated list of argument names
7LIST OF INTEGERargumentDataTypesList of parameter data types
8STRINGdescriptionOptional. User added information/documentation, explaining the purpose of the method

Return Value


Error rendering macro 'excerpt-include' : User 'null' does not have permission to view the page 'US:_r_XPX_Return_Value'.

Options


 

Example


<Missing Example>

 

See also

Filter by label

There are no items with the selected labels at this time.