All Frameworks Class Hierarchy This Framework Indexes
CATPDMReconcile Interface CATIPDMCriterionScm
Usage: you can freely reimplement this interface.
interface CATIPDMCriterionScm
Interface used by the Reconciliator in order to query in a PDM Destination
for candidate objects for reconciliation.
Role:
This interface is implemented by each criterion. A criterion depends of PDM environment.
A criterion is a late type which name is normalized: CATPDMCrit_Env_CritName
With:
- Env the PDM environment
- and CritName the criterion's name.
We deliver default implementations, but user can create their owns implementations.
- For ENOVIA VPM V4, we deliver Simple query
- For ENOVIA VPM V5, we deliver Easy query
Method Index
- o
CheckCriterionParametersXML(CATScmObject*,CATUnicodeString&)
- Checks query parameters values.
- o
ExecuteCriterion(CATScmObject*,CATListValCATUnicodeString&,CATLISTP(CATScmPDMObject)&,CATListValCATUnicodeString&)
- Executes current query on PDM.
- o
ExecuteCriterionXML(CATScmObject*,CATUnicodeString&,CATLISTP(CATScmPDMObject)&,CATListValCATUnicodeString&)
- Executes current query on VPDM with query parameters inside an XML stream .
- o
GetCriterionMode(int&)
- Define how criterion operates.
- o
GetCriterionParameters(CATScmObject*,CATListValCATUnicodeString&,CATListValCATUnicodeString&)
- Gets the list of parameters and default values of the PDM objects' query.
- o
GetCriterionParametersXML(CATScmObject*,CATUnicodeString&)
- Gets query parameters with default values.
- o
GetName(CATUnicodeString&)
- Provides criterion name.
- o
GetOrderIndex(int&)
- Gets order index.
- o
IsApplicable(CATScmObject*)
- Answers if the criterion is applicable to an object.
Methods
o CheckCriterionParametersXML
| public virtual CheckCriterionParametersXML( | | ixScmObj, |
| | iocXmlQueryStream) |
-
Checks query parameters values.
Role: Checks query parameters values as an XML stream compliant with Reconciliator Query panel.
- Parameters:
-
- ixScmObj
- Object where we find the criterion’s value.
- iocXmlQueryStream
- XML stream defining query parameters with values.
- Returns:
- Error code of function.
Legal values: Returns S_OK if operation runs well.
o ExecuteCriterion
| public virtual ExecuteCriterion( | | iCATRecObj, |
| | iQueryValueList, |
| | oPDMRecObjList, |
| | oPDMColumnNameList) |
-
Executes current query on PDM.
Role: Creates in CV5 the list of handles of the objects stored in PDM which verify
the criterion according to the criterion’s value of the object.
NB: (This service will be replace in V5R17 by a new one @see #ExecuteCriterion .)
- Parameters:
-
- iCATRecObj
- Object where we find the criterion’s value.
- iQueryValueList
- List of values for the query.
- oPDMRecObjList
- List of wrists on object stored in PDM which verify the criterion.
- oPDMColumnNameList
- List of column names describing the PDM object's attributes. (see
CATScmPDMObject)
- Returns:
- Error code of function.
Legal values: Returns S_OK if operation runs well.
o ExecuteCriterionXML
| public virtual ExecuteCriterionXML( | | ixScmObj, |
| | icXmlQueryStream, |
| | oPDMRecObjList, |
| | oPDMColumnNameList) |
-
Executes current query on VPDM with query parameters inside an XML stream .
Role: Executes current query on VPDM with query parameters inside an XML stream compliant
with Reconciliator Query panel.
The result will be a list of handles of the objects stored in PDM which verify query defined through the input XML stream.
- Parameters:
-
- ixScmObj
- Object where we find the criterion’s value.
- icXmlQueryStream
- XML stream defining query parameters with values.
- oPDMRecObjList
- List of objects stored in PDM which verify the criterion.
- oPDMColumnNameList
- List of column names describing the PDM object's attributes. (see
CATScmPDMObject)
- Returns:
- Error code of function.
Legal values: Returns S_OK if operation runs well.
- Returns:
- Error code of function.
Legal values: Returns S_OK if operation runs well.
o GetCriterionMode
| public virtual GetCriterionMode( | | onMode) |
-
Define how criterion operates.
Role: Define how criterion operates (Old mode with list of strings or new mode with XML).
- Parameters:
-
- onMode
- Define which services has to be used with this criterion.
Legal values:
- CATScmCriterionModeList
- Old mode based on 2 list of strings
- CATScmCriterionModeXML
- New mode with XML
- Returns:
- Error code of function.
Legal values: Returns S_OK if operation runs well.
o GetCriterionParameters
| public virtual GetCriterionParameters( | | iCATRecObj, |
| | oQueryLabelList, |
| | oQueryValueList) |
-
Gets the list of parameters and default values of the PDM objects' query.
Role: Gets the list of parameters and default values of the PDM objects' query.
NB: (This service will be replace in V5R17 by a new one @see #GetCriterionParameters .)
- Parameters:
-
- iRecObj
- Object where we find the criterion’s value.
- oQueryLabelList
- List of labels for the query.
- oQueryValueList
- List of default values for the query.
- Returns:
- Error code of function.
Legal values: Returns S_OK if operation runs well.
o GetCriterionParametersXML
| public virtual GetCriterionParametersXML( | | ixScmObj, |
| | ocXmlQueryStream) |
-
Gets query parameters with default values.
Role: Gets query parameters with default values as an XML stream compliant with Reconciliator Query panel.
- Parameters:
-
- ixScmObj
- Object where we find the criterion’s value.
- ocXmlQueryStream
- XML stream defining query parameters and default values.
- Returns:
- Error code of function.
Legal values:
- S_OK
- if operation runs well and criterion has some parameters to value.
- S_FALSE
- if operation runs well and criterion has no parameter to value.
- E_FAIL
- otherwise.
o GetName
| public virtual GetName( | | oName) |
-
Provides criterion name.
Role: Provide a NLS Display name of the criterion.
- Parameters:
-
- oName
- To output the Display name.
- Returns:
- Error code of function.
Legal values: Returns S_OK if operation runs well.
o GetOrderIndex
| public virtual GetOrderIndex( | | onOrder) |
-
Gets order index.
Role: Provides a index to enable to order list of Criterion.
- Parameters:
-
- onOrder
- To output the value enabling to order criterion list on CATScmObject.
- Returns:
- Error code of function.
Legal values: Returns S_OK if operation runs well.
o IsApplicable
| public virtual IsApplicable( | | iCATRecObj) |
-
Answers if the criterion is applicable to an object.
Role: Answers if the criterion is applicable to an object.
- Parameters:
-
- iCATRecObj
- Object on which criterion need to be applied.
- Returns:
- Error code of function.
Legal values: Returns S_OK if operation runs well.
This object is included in the file: CATIPDMCriterionScm.h
If needed, your Imakefile.mk should include the module: CATPDMReconcileItfCPP