All Frameworks Class Hierarchy This Framework Previous Next Indexes
CATPDMBaseInterfaces Interface CATIPDMPersistency
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---CATIPDMPersistency
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIPDMPersistency
Method Index
- o
AlreadyPersistedInPDM()
- Returns if the document has already been stored in the PDM
This could be keeping the document in the vault, exposing or not its content (mode PermanentBlackBox or PermanentExposed)
Or just keeping its content, and not keeping the document (mode VolatileExposed)
- o
CurrentVaultMode(VaultMode&)
- Return the actual vault mode for that document
- o
LockByCurrentUser()
- Test if the document is locked by the current user
- o
SetVaultMode(VaultMode)
- Set the vault mode for that document
Enumerated Type Index
- o
VaultMode
- VaultMode
NotDefined = 0
PermanentBlackBox = 1
PermanentExposed = 2
VolatileExposed = 4
Methods
o AlreadyPersistedInPDM
public virtual HRESULT AlreadyPersistedInPDM( | )= 0 |
-
Returns if the document has already been stored in the PDM
This could be keeping the document in the vault, exposing or not its content (mode PermanentBlackBox or PermanentExposed)
Or just keeping its content, and not keeping the document (mode VolatileExposed)
- Returns:
- S_OK : The document has been already stored
S_FALSE : The document has never been stored
o CurrentVaultMode
public virtual HRESULT CurrentVaultMode( | VaultMode& | oCurrent) = 0 |
-
Return the actual vault mode for that document
- Parameters:
-
- oCurrent
- OUT the returned actual vaults mode
- Returns:
- S_OK
E_FAIL
o LockByCurrentUser
public virtual HRESULT LockByCurrentUser( | )= 0 |
-
Test if the document is locked by the current user
- Returns:
- S_OK : Locked by the current user
S_FALSE : Not locked by the current user
E_FAIL : Not documented error
o SetVaultMode
public virtual HRESULT SetVaultMode( | VaultMode | Mode) = 0 |
-
Set the vault mode for that document
- Parameters:
-
- Mode
- the mode to set
- Returns:
- S_OK
E_FAIL : The passed in mode is not compatible with the Possible mode
Enumerated Types
o VaultMode
-
enum VaultMode {
NotDefined,
PermanentBlackBox,
PermanentExposed,
VolatileExposed
}
VaultMode
NotDefined = 0
PermanentBlackBox = 1
PermanentExposed = 2
VolatileExposed = 4
This object is included in the file: CATIPDMPersistency.h
If needed, your Imakefile.mk should include the module: CATPDMBaseItf