xpfValidateInstanceTypeWithParametersBN

 
SYNTAX:
 
xpfValidateInstanceTypeWithParametersBN (modelId                    : GENERIC;
                                         entityName                 : STRING;
                                         diagnosticFile             : STRING;
                                         options                    : INTEGER;
                                         ruleSchemaName             : STRING;
                                         userOutputFile             : STRING;
                                         VAR validationResultId     : GENERIC;
                                         VAR returnValue            : GENERIC;
                                         numberOfParameters         : INTEGER;
                                         argument1, ... , argumentN : GENERIC)
                                         result                     : LOGICAL;
 
This function invokes the EDMmodelChecker^TM to validate all instances of the specified instance type in the specified data model. When the XPXSUBTYPES is set in the options argument, all instances in the actual model that are subtypes of the specified type, will be validated as well.
The result of the validation can be a text report, a population of the Express schema EDM_Validation_Result_Schema or both. A population of the EDM_Validation_Result_Schema enables the caller to make his own diagnostic report in his own format.
 
There exist two options that will influence the amount of information in the validation report produced by this function: XPXNO_PRINT_OUTPUT and XPXFULL_OUTPUT
A standard validation report will be produced when none of these options are set in the <options> argument. A validation report with all available detailed information is produced when the XPXFULL_OUTPUT option is set. No validation report will be produced when the XPXNO_PRINT_OUTPUT option is enabled. The validation result would then normally be in a population of the EDM_Validation_Result_Schema.
 
When validating an instance against rules specified in an EDMruleSchema, only he following validation options are effective: XPXFULL_VALIDATION, XPXGLOBAL_RULES, XPXLOCAL_RULES, XPXUNIQUENESS_RULES. XPXULL_VALIDATION means in this context: XPXGLOBAL_RULES ~| XPXLOCAL_RULES ~| XPXUNIQUENESS_RULES .
A number of arguments can be supplied to the ?instance type validation process?
in the arguments argument1, ?, argumentN. Hence the validation process can be made parameterized. The validation process can return a value to the caller through the returnValue argument. The value to return must be set in the validation process by invoking the xpxReturnValueToCaller operation.
 
See related functions: xpxGetNumberOfUserParameters, xpxGetUserParameter
 
This function is only applicable to application instances.
The data model that holds the instance to validate must be open before this operation can be successfully performed.
The argument <options> specifies the options that should be used during the validation. The <options> argument should be specified as a zero or as a sum of one or more of the following integer constants:
 
XPXSUBTYPE XPXAGGREGATE_DATA_TYPE
XPXFULL_VALIDATION XPXAGGREGATE_SIZE
XPXGLOBAL_RULES XPXARRAY_REQUIRED_ELEMENTS
XPXLOCAL_RULES XPXAGGREGATE_UNIQUENESS
XPXINVERSE_RULES XPXUNSET_DERIVE_ATTRIBUTES
XPXUNIQUENESS_RULES XPXOUTPUT_STEPID
XPXREQUIRED_ATTRIBUTES XPXFULL_OUTPUT
XPXATTRIBUTE_DATA_TYPE XPXSTOP_ON_FIRST_ERROR
This function is equivalent to the EDMinterface^TM function edmiValidateInstanceTypeWithParametersBN.