All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMPersistency Class ENOVEventSubFilter

Usage: you must use this class as is. You should never derive it.


public class ENOVEventSubFilter

Class representing a filter that applies to a given subscription.
Role:
Reduces the number of notifications according to specific filters.


Method Index


o ConvertStringToCategory(CATUnicodeString&)
Converts a string to an enum value.
o GetCategoryAsString()
Gets the filter category.
o GetCategory()
Gets the filter category.
o GetName()
Gets the filter name.
o GetType()
Gets the filter type.
o GetValueAsString()
Gets the filter value.
o GetValue()
Gets the filter value.

Enumerated Type Index


o CATEGORY
Enum to class filters in categories.
o CATEGORY

Methods


o ConvertStringToCategory
public static ConvertStringToCategory( const iString)
Converts a string to an enum value.
Role : Retrieves the category of the filter from a string.
Parameters:
iString
a string representing the category of the filter
Returns:
an enum value giving the CATEGORY of the filter
o GetCategoryAsString
public GetCategoryAsString()
Gets the filter category.
Role : Retrieves the category of the filter.
Returns:
a string representing the category of the filter
o GetCategory
public GetCategory()
Gets the filter category.
Role : Retrieves the category of the filter.
Returns:
an enum value giving the CATEGORY of the filter
o GetName
public GetName()
Gets the filter name.
Role : Retrieves the name of the filter.
Returns:
a string giving the name of the filter
o GetType
public GetType()
Gets the filter type.
Role : Retrieves the type of the filter.
Returns:
a string giving the type of the filter
o GetValueAsString
public GetValueAsString()
Gets the filter value.
Role : Retrieves the value of the filter.
Returns:
a string representing the value of the filter
o GetValue
public GetValue()
Gets the filter value.
Role : Retrieves the value of the filter.
Returns:
the value of the filter

Enumerated Types


o CATEGORY
enum CATEGORY {
  NONE,
  ON_EVENT,
  ON_PUBLISHER,
  ON_ACTION,
  ON_ATTRIBUTES
}
Enum to class filters in categories.
Role : Splits filters in three main categories.
o CATEGORY
enum CATEGORY {
  NONE,
  ON_EVENT,
  ON_PUBLISHER,
  ON_ACTION
}

This object is included in the file: ENOVEventSubFilter.h
If needed, your Imakefile.mk should include the module: VX0FACTO

Copyright © 2003, Dassault Systèmes. All rights reserved.