All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmGraphPredicat

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIVpmGraphPredicat
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIVpmGraphPredicat

This class enables to access to predicates of the LCA lifecycle status graph model.


Method Index


o GetName(CATUnicodeString&)
Get the predicate name.
o GetPredicateDefinition(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Get all information linked to the predicate.
o GetStringPredicate(CATUnicodeString&)
Get the query predicate.
o SetPredicateDefinition(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Set all information linked to the predicate.
o SetStringPredicate(CATUnicodeString&)
Set the query predicate.

Methods


o GetName
public virtual HRESULT GetName(CATUnicodeString& oPredicatename)= 0
Get the predicate name. Equivalent to pool_variable Name.
Parameters:
oPredicatename
- name of the predicate
Returns:

Legal values
S_OK
Condition is true
E_FAIL
An error occurs during the execution
o GetPredicateDefinition
public virtual HRESULT GetPredicateDefinition(CATUnicodeString& oPredicateExpression,
CATUnicodeString& oPredicateOperator,
CATUnicodeString& oPredicateValue)=0
Get all information linked to the predicate.
Parameters:
oPredicateExpression
-
oPredicateOperator
-
oPredicateValue
-
Returns:

Legal values
S_OK
The predicate is ok
E_FAIL
An error occurs during the execution
o GetStringPredicate
public virtual HRESULT GetStringPredicate(CATUnicodeString& oPredicate)= 0
Get the query predicate.
Parameters:
oPredicate
-
Returns:

Legal values
S_OK
Done
E_FAIL
An error occurs during the execution
o SetPredicateDefinition
public virtual HRESULT SetPredicateDefinition( const CATUnicodeString& iPredicateExpression,
const CATUnicodeString& iPredicateOperator,
const CATUnicodeString& iPredicateValue)=0
Set all information linked to the predicate.
Parameters:
iPredicateExpression
-
iPredicateOperator
-
iPredicateValue
-
Returns:

Legal values
S_OK
The modification is ok
E_FAIL
An error occurs during the execution
o SetStringPredicate
public virtual HRESULT SetStringPredicate( const CATUnicodeString& iPredicate)= 0
Set the query predicate.
Parameters:
iPredicate
-
Returns:

Legal values
S_OK
Done
E_FAIL
An error occurs during the execution

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

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