All Frameworks  Class Hierarchy  This Framework  Indexes   

VPMInterfaces Interface CATIVpmAFLHistory

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


interface CATIVpmAFLHistory

Class to manage the Action Flow History objects.
Role: History objects are created, as changes are made under Action control, in order to provide a record of the chain of events during an Action's lifetime.


Method Index


o Dump(char*)
Dumps the History attributes.
o GetActionStatus(CATUnicodeString&)
Retrieves the Action status.
o GetCreationDate(CATTime&)
Retrieves the creation date.
o GetDate(CATTime&)
This method is obsolete : use GetCreationDate().
o GetDescription(CATUnicodeString&)
Retrieves the description text.
o GetLastModifDate(CATTime&)
Retrieves the last modification date.
o GetObjId1(CORBAAny&)
Retrieves the Object1 identifier.
o GetObjId1(SEQUENCE(octet)&)
Retrieves the Object1 identifier.
o GetObjId2(CORBAAny&)
Retrieves the Object2 identifier.
o GetObjId2(SEQUENCE(octet)&)
Retrieves the Object2 identifier.
o GetObjName1(CATUnicodeString&)
Retrieves the Object1 name.
o GetObjName2(CATUnicodeString&)
Retrieves the Object2 name.
o GetOperation(CATUnicodeString&)
Retrieves the History operation.
o GetProductView(CATIVpmAFLProductView_var&)
Retrieves the ProductView.
o GetRelatedAction(CATIVpmAFLAction_var&)
Retrieves the related Action.
o GetType(CATUnicodeString&)
Retrieves the History type.
o GetUser(CATUnicodeString&)
Retrieves the user attribute.
o SetDescription(CATUnicodeString&)
Assigns the description text.
o SetObjId1(CORBAAny&)
Assigns the Object1 identifier.
o SetObjId1(SEQUENCE(octet)&)
Assigns the Object1 identifier.
o SetObjId2(CORBAAny&)
Assigns the Object2 identifier.
o SetObjId2(SEQUENCE(octet)&)
Assigns the Object2 identifier.
o SetObjName1(CATUnicodeString&)
Assigns the Object1 name.
o SetObjName2(CATUnicodeString&)
Assigns the Object2 name.
o SetOperation(CATUnicodeString&)
Assigns the History operation.
o SetProductView(CATIVpmAFLProductView_var&)
Assigns a ProductView.
o SetType(CATUnicodeString&)
Assigns the History type.

Methods


o Dump
public virtual Dump( iPrefix)
Dumps the History attributes.
Parameters:
iPrefix
The prefix text for each output line.
o GetActionStatus
public virtual GetActionStatus( oStatus)
Retrieves the Action status.
Parameters:
oStatus
The Action status.
o GetCreationDate
public virtual GetCreationDate( oTime)
Retrieves the creation date.
Parameters:
oTime
The creation date attribute.
o GetDate
public virtual GetDate( oDate)
This method is obsolete : use GetCreationDate().
o GetDescription
public virtual GetDescription( oString)
Retrieves the description text.
Parameters:
oString
The description text.
o GetLastModifDate
public virtual GetLastModifDate( oTime)
Retrieves the last modification date.
Parameters:
oTime
The last modification date attribute.
o GetObjId1
public virtual GetObjId1( oIdentifier)
Retrieves the Object1 identifier.
Parameters:
oIdentifier
The identifier of Object1.
o GetObjId1
public virtual GetObjId1( oIdentifier)
Retrieves the Object1 identifier.
Parameters:
oIdentifier
The identifier of Object1.
o GetObjId2
public virtual GetObjId2( oIdentifier)
Retrieves the Object2 identifier.
Parameters:
oIdentifier
The identifier of Object2.
o GetObjId2
public virtual GetObjId2( oIdentifier)
Retrieves the Object2 identifier.
Parameters:
oIdentifier
The identifier of Object2.
o GetObjName1
public virtual GetObjName1( oName)
Retrieves the Object1 name.
Parameters:
oName
The name of Object1.
o GetObjName2
public virtual GetObjName2( oName)
Retrieves the Object2 name.
Parameters:
oName
The name of Object2.
o GetOperation
public virtual GetOperation( oOperation)
Retrieves the History operation.
Parameters:
oOperation
The History operation attribute.
o GetProductView
public virtual GetProductView( oView)
Retrieves the ProductView.
Parameters:
oView
The ProductView object.
o GetRelatedAction
public virtual GetRelatedAction( oAction)
Retrieves the related Action.
Parameters:
oAction
The related Action.
o GetType
public virtual GetType( oType)
Retrieves the History type.
Parameters:
oType
The History type attribute.
o GetUser
public virtual GetUser( oUser)
Retrieves the user attribute.
Parameters:
oUser
The user attribute.
o SetDescription
public virtual SetDescription( const iString)
Assigns the description text.
Parameters:
iString
The description text.
o SetObjId1
public virtual SetObjId1( iIdentifier)
Assigns the Object1 identifier.
Parameters:
iIdentifier
The identifier of Object1.
o SetObjId1
public virtual SetObjId1( const iIdentifier)
Assigns the Object1 identifier.
Parameters:
iIdentifier
The identifier of Object1.
o SetObjId2
public virtual SetObjId2( iIdentifier)
Assigns the Object2 identifier.
Parameters:
iIdentifier
The identifier of Object2.
o SetObjId2
public virtual SetObjId2( const iIdentifier)
Assigns the Object2 identifier.
Parameters:
iIdentifier
The identifier of Object2.
o SetObjName1
public virtual SetObjName1( const iName)
Assigns the Object1 name.
Parameters:
iName
The name of Object1.
o SetObjName2
public virtual SetObjName2( const iName)
Assigns the Object2 name.
Parameters:
iName
The name of Object2.
o SetOperation
public virtual SetOperation( const iOperation)
Assigns the History operation.
Parameters:
iOperation
The History operation attribute.
o SetProductView
public virtual SetProductView( const iView)
Assigns a ProductView.
Parameters:
iView
The ProductView object.
o SetType
public virtual SetType( const iType)
Assigns the History type.
Parameters:
iType
The History type attribute.

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

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