All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

VPMWorkflow Class CATVpmWflServices

CATVpmWflServices
 

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


public class CATVpmWflServices

Class for static functions.
Role: This class implements some usefull functions:


Constructor and Destructor Index


o CATVpmWflServices()
o ~CATVpmWflServices()

Method Index


o GetUniqueName(CATUnicodeString,CATUnicodeString&)
Construct a unique name for a workflow object depending on its type.
o GetVpmFactoryManager(CATIVpmFactoryManager_var&)
Get a handler to VPM factory manager.
o SendMail(CATUnicodeString&,CATUnicodeString&,CATUnicodeString&)
Send an email to a given user.

Constructor and Destructor


o CATVpmWflServices
public CATVpmWflServices()
o ~CATVpmWflServices
public virtual ~CATVpmWflServices()

Methods


o GetUniqueName
public static HRESULT GetUniqueName( const CATUnicodeString iType,
CATUnicodeString& oUName)
Construct a unique name for a workflow object depending on its type.
Legal values: S_OK If the operation succeeds. E_FAIL Otherwise
Parameters:
iType
The type of the object for whihc the name is to be constructed.
oUName
The name constructed.
o GetVpmFactoryManager
public static HRESULT GetVpmFactoryManager(CATIVpmFactoryManager_var& oFactoryMgr)
Get a handler to VPM factory manager.
Legal values: S_OK If the operation succeeds. E_FAIL Otherwise
Parameters:
oFactoryMgr
o SendMail
public static HRESULT SendMail( const CATUnicodeString& iToUser,
const CATUnicodeString& iSubject,
const CATUnicodeString& iMessage)
Send an email to a given user.
Legal values: S_OK If the operation succeeds. E_FAIL Otherwise.
Parameters:
iToUser
The id. of the user to whom the email is to be sent.
iSubject
The subject of the email.
iMessage
The body of the email.

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

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