All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

VPMInterfaces Interface CATIVpmGraphStatus

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

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


interface CATIVpmGraphStatus

This interface is implemented by the status objects of the LCA lifecycle status graph model.


Method Index


o DoesSystemStatus(CATIVpmGraphStatus::ENOVIAStatus)
To know if a status is defined as a System Status.
o GetListOfTransitions(CATLISTV(CATBaseUnknown_var)&)
Get the list of transitions.
o GetName(CATUnicodeString&)
Get the name of the status.
o GetSubStatus(CATUnicodeString&)
Get the name of the substatus.
o RemoveSystemStatus(CATIVpmGraphStatus::ENOVIAStatus)
Undefine status as a System status.
o SetSubStatus(CATUnicodeString&)
Set the substatus.
o SetSystemStatus(CATIVpmGraphStatus::ENOVIAStatus)
Define status as a System status.

Enumerated Type Index


o ENOVIAStatus

Methods


o DoesSystemStatus
public virtual HRESULT DoesSystemStatus(CATIVpmGraphStatus::ENOVIAStatus iStatus)=0
To know if a status is defined as a System Status.
Parameters:
iStatus
-
Returns:

Legal values
S_OK
The status is defined as a System status
S_FALSE
The status is not defined as a System status
E_FAIL
A problem occurs
o GetListOfTransitions
public virtual HRESULT GetListOfTransitions(CATLISTV(CATBaseUnknown_var)& oListOfTransition)= 0
Get the list of transitions.
Parameters:
oListOfTransition
-
Returns:

Legal values
S_OK
Operation succeeded
E_FAIL
A problem occurs
o GetName
public virtual HRESULT GetName(CATUnicodeString& oStatusName)= 0
Get the name of the status.
Parameters:
oStatusName
-
Returns:

Legal values
S_OK
Operation succeeded
E_FAIL
A problem occurs
o GetSubStatus
public virtual HRESULT GetSubStatus(CATUnicodeString& oSubStatusName)= 0
Get the name of the substatus.
Parameters:
oSubStatusName
-
Returns:

Legal values
S_OK
Operation succeeded
E_FAIL
A problem occurs
o RemoveSystemStatus
public virtual HRESULT RemoveSystemStatus(CATIVpmGraphStatus::ENOVIAStatus iStatus)=0
Undefine status as a System status.
Parameters:
iStatus
-
Returns:

Legal values
S_OK
The status is now not defined as a System status
E_FAIL
A problem occurs
o SetSubStatus
public virtual HRESULT SetSubStatus( const CATUnicodeString& oSubStatusName)= 0
Set the substatus.
Parameters:
iSubStatusName
-
Returns:

Legal values
S_OK
Operation succeeded
E_FAIL
A problem occurs
o SetSystemStatus
public virtual HRESULT SetSystemStatus(CATIVpmGraphStatus::ENOVIAStatus iStatus)=0
Define status as a System status.
Parameters:
iStatus
-
Returns:

Legal values
S_OK
The status is now defined as a System status
E_FAIL
A problem occurs

Enumerated Types


o ENOVIAStatus
enum ENOVIAStatus {
  Proposed,
  InWork,
  ChangeControl,
  Released,
  Obsolete,
  Rejected,
  Modify,
  Delete,
  Rel_state,
  Prerelease
}

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

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