All Frameworks Class Hierarchy This Framework Previous Indexes
ENOVDesktopDocument Interface ENOVIChangeStatusTOCUE
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIChangeStatusTOCUE
Usage: you can freely reimplement this interface.
interface ENOVIChangeStatusTOCUE
Interface to ChangeStatusUserExit.
Role: Interface for using ChangeStatusUserExit. This User Exit can be implemented to change
the default behaviors of change status on a TOC and its sheets. The default behavior of
promoting a TOC is to promote all of its linked sheet documents, as long as the sheet is in
the same state as TOC. If some sheets are in a lower state than the current state of this TOC,
it will only promote these sheets to advance to next level and leave TOC status unchanged.
Demoting a TOC will only demote the TOC itself. When demoting a sheet document, if the sheet
document is in a state lower than or equal to the state of its TOC, the demotion will fail.
Promoting a sheet document doesn't depend on status of its TOC.
Method Index
- o
demote_TOC_UE(ENOVITOCVersion_var&,boolean&)
- Called before TOC is to be demoted.
- o
demote_sheet_UE(ENOVITOCVersion_var&,ENOVIDocumentRevision_var&,int&,int&,boolean&)
- Called before a sheet document is to be demoted.
- o
promote_TOC_UE(ENOVITOCVersion_var&,boolean&,boolean&)
- Called before the TOC is to be promoted.
- o
promote_lower_sheet_UE(ENOVITOCVersion_var&,ENOVIDocumentRevision_var&,boolean&)
- Called before sheet document that is in a lower state than TOC's state is to be promoted.
- o
promote_sheet_UE(ENOVITOCVersion_var&,ENOVIDocumentRevision_var&,boolean&)
- Called before a sheet document is to be promoted.
- o
promote_sheet_with_TOC_UE(ENOVITOCVersion_var&,ENOVIDocumentRevision_var&,int&,int&,boolean&)
- Called before each sheet under the TOC is to be promoted.
Methods
o demote_TOC_UE
public virtual HRESULT demote_TOC_UE( | const ENOVITOCVersion_var& | iTocVer, |
| boolean& | returnCode) = 0 |
-
Called before TOC is to be demoted. If the returnCode is FALSE, TOC will not be demoted. Default return code is TRUE.
- Parameters:
-
- iTocVer
- The TOC
- returnCode
- TRUE or FALSE
o demote_sheet_UE
public virtual HRESULT demote_sheet_UE( | const ENOVITOCVersion_var& | iTocVer, |
| const ENOVIDocumentRevision_var& | iSheetRev, |
| const int& | iTOCState, |
| const int& | iSheetState, |
| boolean& | returnCode) = 0 |
-
Called before a sheet document is to be demoted. If the returnCode is FALSE, the sheet will not be demoted. Default return code value is FALSE if the state of this sheet is equal to or lower than TOC's state. Otherwise return code is TRUE.
- Parameters:
-
- iTocVer
- The TOC
- iSheetRev
- The document revision
- returnCode
- TRUE or FALSE
o promote_TOC_UE
public virtual HRESULT promote_TOC_UE( | const ENOVITOCVersion_var& | iTocVer, |
| const boolean& | in_lower_sheets_exist_flag, |
| boolean& | returnCode) = 0 |
-
Called before the TOC is to be promoted. If the returnCode is FALSE, the TOC will not be promoted. Default return code value is FALSE if there exist sheets that are in lower state than TOC (based on the input flag in_lower_sheets_exist_flag), and TRUE otherwise.
- Parameters:
-
- iTocVer
- The TOC
- in_lower_sheets_exist_flag
- input boolean true or false
- returnCode
- TRUE or FALSE
o promote_lower_sheet_UE
public virtual HRESULT promote_lower_sheet_UE( | const ENOVITOCVersion_var& | iTocVer, |
| const ENOVIDocumentRevision_var& | iSheetRev, |
| boolean& | returnCode) = 0 |
-
Called before sheet document that is in a lower state than TOC's state is to be promoted.
- Parameters:
-
- iTocVer
- The TOC
- iSheetRev
- The document revision
- returnCode
- TRUE or FALSE
o promote_sheet_UE
public virtual HRESULT promote_sheet_UE( | const ENOVITOCVersion_var& | iTocVer, |
| const ENOVIDocumentRevision_var& | iSheetRev, |
| boolean& | returnCode) = 0 |
-
Called before a sheet document is to be promoted.
- Parameters:
-
- iTocVer
- The TOC
- iSheetRev
- The document revision
- returnCode
- TRUE or FALSE
o promote_sheet_with_TOC_UE
public virtual HRESULT promote_sheet_with_TOC_UE( | const ENOVITOCVersion_var& | iTocVer, |
| const ENOVIDocumentRevision_var& | iSheetRev, |
| const int& | iTOCState, |
| const int& | iSheetState, |
| boolean& | returnCode) = 0 |
-
Called before each sheet under the TOC is to be promoted. The returnCode value is FALSE if a sheet is in a state not equal to TOC state, otherwise its value is TRUE.
- Parameters:
-
- iTocVer
- The TOC
- iSheetRev
- The document revision
- iTOCState
- State number
- iSheetState
- State number
- returnCode
- TRUE or FALSE
This object is included in the file: ENOVIChangeStatusTOCUE.h
If needed, your Imakefile.mk should include the module: VX0CRTUE