All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface CATICfgFilter
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATICfgFilter
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATICfgFilter
Interface to manage a Configuration Filter.
Role:
The Configuration Filter evaluates the Effectivity validity of a given list
of objects, for a specified Domain and Filtering Mode.
A Configuration Filter is composed of a list of criteria which can be:
- Date Intervals
- Range Intervals
- Specifications
- Modifications
- can not be mixed with other kinds of criteria
Those criteria must be set as CATICfgNormalValue objects.
Since V5R8, only Multi-Level Filters can be created using the
CATICfgManager.CreateMultiLevelFilter method.
- See also:
-
CATICfgNormalValue
Method Index
- o
AddCondition(CATICfgNormalValue_var&)
- Adds a criterion to the Filter.
- o
Filter(CATListOfCATILinkableObject&,CATListOfCATILinkableObject&)
- Evaluates the validity, against this Configuration Filter, of a set of objects.
- o
GetListOfFilters(CATIConfigurableObject_var&,CATUnicodeString&,CATListValCATICfgNormalValue_var&)
- Returns the Filter criteria list.
- o
GetModeUnsolvedOp(CATBoolean&)
- Get filtering mode for Unsolved Operations.
- o
SetBSFFilter(CATUnicodeString&)
- Postpones the building of a filter.
- o
SetModeUnsolvedOp(CATBoolean&)
- Show/Hide Unsolved Operations.
- o
getDomain(CATUnicodeString&)
- Returns the Domain of the Filter.
- o
getFilteringMode(CATICfgFilter::FilteringMode&)
- Returns the Filtering Mode.
- o
getMode150(CATBoolean&)
- Returns the 150% flag value.
- o
resetCriteria()
- Removes all the criteria from the Filter.
- o
setDomain(CATUnicodeString&)
- Sets the Domain of the Filter.
- o
setFilteringMode(CATICfgFilter::FilteringMode&)
- Sets the Filtering Mode.
- o
setMode150(CATBoolean&)
- Activates/desactivates the 150% filtering mode.
Enumerated Type Index
- o
FilteringMode
- Enumeration of the possible Filtering Modes.
Methods
o AddCondition
public virtual HRESULT AddCondition( | const CATICfgNormalValue_var& | iCondition)= 0 |
-
Adds a criterion to the Filter.
The criteria can be an Interval (date or range), a Specification or
a Modification, but must be passed as a
CATICfgNormalValue.
To create such a CATICfgNormalValue, use the
CATICfgManager.CreateNormalValue methods
- Parameters:
-
- iCondition
- The criterion to add.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The criterion is successfully added.
- E_FAIL
- An error occured during the criterion insertion.
o Filter
public virtual HRESULT Filter( | const CATListOfCATILinkableObject& | iListObjectToFilter, |
| CATListOfCATILinkableObject& | oListFilteredObject)= 0 |
-
Evaluates the validity, against this Configuration Filter, of a set of objects.
- Parameters:
-
- iListObjectToFilter
- The list of objects to filter.
- oListFilteredObject
- The list of objects filtered-in.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The evaluation is successful.
- E_FAIL
- An error occured during the evaluation.
o GetListOfFilters
public virtual HRESULT GetListOfFilters( | CATIConfigurableObject_var& | oContext, |
| CATUnicodeString& | oDomain, |
| CATListValCATICfgNormalValue_var& | oConditionList)const = 0 |
-
Returns the Filter criteria list.
- Parameters:
-
- oContext
- The Configurable Object to which the Filter is associated. Since V5R8, this parameter
is not relevant anymore. The returned value should be ignored.
- oDomain
- The Domain name. Same as
CATICfgFilter.getDomain.
- oConditionList
- The criteria list.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The data extraction is successful.
- E_FAIL
- An error occured during the data extraction.
o GetModeUnsolvedOp
-
Get filtering mode for Unsolved Operations.
- Parameters:
-
- oShow
- If TRUE, Unsolved Operations are shown.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The filtering mode is successfully read.
- E_FAIL
- An error occured while reading the filtering mode.
o SetBSFFilter
-
Postpones the building of a filter.
The filter will be built after the DMU filter pass with the result of the DMU filter.
- Parameters:
-
- iFilterName
- The name of the BSF filter.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The BSF name is successfully set.
- E_FAIL
- An error occured during the BSF name setting.
o SetModeUnsolvedOp
-
Show/Hide Unsolved Operations.
- Parameters:
-
- iShow
- If activated, Unsolved Operations are shown.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Filtering Mode is successfully set.
- E_FAIL
- An error occured during the Filtering Mode setting.
o getDomain
-
Returns the Domain of the Filter.
- Parameters:
-
- oValue
- The Domain name.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Domain is successfully extracted.
- E_FAIL
- An error occured during the Domain extraction.
o getFilteringMode
public virtual HRESULT getFilteringMode( | CATICfgFilter::FilteringMode& | oValue)const = 0 |
-
Returns the Filtering Mode.
- Parameters:
-
- oValue
- The Filtering Mode.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Filtering Mode is successfully extracted.
- E_FAIL
- An error occured during the Filtering Mode extraction.
o getMode150
-
Returns the 150% flag value.
- Parameters:
-
- oValue
- The 150% flag value.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The 150% flag is successfully extracted.
- E_FAIL
- An error occured during the 150% flag extraction.
o resetCriteria
public virtual HRESULT resetCriteria( | )= 0 |
-
Removes all the criteria from the Filter.
This method does not change the Domain nor the Filtering Mode.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The criteria list is successfully cleared.
- E_FAIL
- An error occured during the criteria list reset.
o setDomain
-
Sets the Domain of the Filter.
- Parameters:
-
- iValue
- The Domain name.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Domain is successfully changed.
- E_FAIL
- An error occured during the Domain change.
o setFilteringMode
public virtual HRESULT setFilteringMode( | const CATICfgFilter::FilteringMode& | iValue)= 0 |
-
Sets the Filtering Mode.
- Parameters:
-
- iValue
- The Filtering Mode to set.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The Filtering Mode is successfully set.
- E_FAIL
- An error occured during the Filtering Mode setting.
o setMode150
-
Activates/desactivates the 150% filtering mode.
If activated, the Configuration Filter ignores the Specifications
belonging to Categories not present in the Filter criteria list.
- Parameters:
-
- iValue
- The 150% flag value.
- Returns:
- An HRESULT.
Legal values:
- S_OK
- The 150% flag is successfully changed.
- E_FAIL
- An error occured during the 150% flag change.
Enumerated Types
o FilteringMode
-
enum FilteringMode {
Default,
ExactMatch,
PartialMatch,
ReverseMatch
}
Enumeration of the possible Filtering Modes.
Filtering Modes affect the way the Specification "AND" expressions are interpreted
by the Configuration Filter, but do not affect the Interval part.
For a Configuration Filter to consider a Specification "AND" expression valid, the
Specification criteria list in the Filter must:
- Default
- contain at least all the Specifications present in the expression.
- ExactMatch
- contain exactly the Specification list present in the expression, no more, no less.
- PartialMatch
- contain at least one of the Specifications present in the expression.
- ReverseMatch
- Returns the instances which do not satisfy the filter criteria. This mode is opposite of Default mode.
This object is included in the file: CATICfgFilter.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces