All Frameworks Class Hierarchy This Framework Previous Next Indexes
ENOVDDManager Interface ENOVIDocumentRevision
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIDocumentRevision
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIDocumentRevision
Interface for ENOVIDocumentRevision.
Role: This interface defines methods on ENOVIDocumentRevision object.
Method Index
- o
AggregateIteration(CATIVpmFactoryObject_var&)
- Creates an iteration.
- o
CloneDocument(CATUnicodeString&,ENOVIDocumentRevision_var&)
- Clone (making a copy of) a new document from this document.
- o
CopyIteration(CATIVpmFactoryObject_var&,CATIVpmFactoryObject_var&)
- Creates a new iteration from an old iteration.
- o
CreateFormat(ENOVIDocumentIteration_var&,ENOVIIterationFormat_var&,CATUnicodeString&,CATUnicodeString&,SEQUENCE_octet&,CATUnicodeString&,CATUnicodeString&,CATUnicodeString&,boolean,ENOVIIterationFormat_var&)
- This method creates a new format under the input iteration of this document revision.
- o
CreateNewRevision(ENOVIDocumentRevision_var&)
- Create new revision from this revision.
- o
Delete()
- Delete this revision (all of its iterations are to be deleted).
- o
DeleteIteration(CATIVpmFactoryObject_var&)
- Delete an iteration.
- o
Init(CATIAVPMObjectVersion*)
- Initializes a new revision.
- o
IsSheet(boolean&)
- Checks whether this revision is a Sheet.
- o
IsTOC(boolean&)
- Checks whether this revision is a TOC.
- o
UpdateFormat(CATUnicodeString&,CATIVpmFactoryObject_var&)
- Updates a format by given MIMEType.
- o
get_DocIterationCount(long&)
- Retrieves the iteration count.
- o
get_DocIterations(CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves all the iterations.
- o
get_MIMEType(CATListOfCATUnicodeString&)
- Retrieves primary format MIMEType.
- o
get_PreferredIteration(ENOVIDocumentIteration_var&)
- Retrieves the preferred iteration.
- o
get_PrimaryFormat(CATIVpmFactoryObject_var&)
- Retrieves the primary format of preferred iteration.
- o
get_UpdatedFormats(CATListOfCATUnicodeString&,CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves updated formats.
- o
set_MIMEType(CATUnicodeString&)
- Sets primary format MIMEType.
- o
set_PreferredIteration(ENOVIDocumentIteration_var&)
- Set the preferred iteration.
- o
set_PrimaryFormat(ENOVIIterationFormat_var&)
- Set the input format to be primay.
Methods
o AggregateIteration
public virtual HRESULT AggregateIteration( | CATIVpmFactoryObject_var& | oDocIteration)=0 |
-
Creates an iteration.
- Parameters:
-
- oDocIteration
- The new iteration
o CloneDocument
-
Clone (making a copy of) a new document from this document. This copy of document is not identical
to the old document. It only copys the preferred iteration (with its formats). Older iterations
and other links will not be copied.
- Parameters:
-
- iNewVID
- The new document V_ID. If it is empty, it will be defaulted to "Copy of"+old_V_ID. If this new VID is already being used by other document, clone document will fail and
return S_FALSE.
- oNewRev
- The new document revision.
- Returns:
- S_OK if successful. S_FALSE if input V_ID (or "Copy of " + old_V_ID, if input is empty) already exists.
E_FAIL in case of error.
o CopyIteration
public virtual HRESULT CopyIteration( | CATIVpmFactoryObject_var& | iDocIteration, |
| CATIVpmFactoryObject_var& | oNewIter)=0 |
-
Creates a new iteration from an old iteration.
- Parameters:
-
- iDocIteration
- The old iteration
- oNewIter
- The new iteration
o CreateFormat
-
This method creates a new format under the input iteration of this document revision.
- Parameters:
-
- iDocIter
- The input iteration.
- iFormatToBeReplaced
- The input format. If its value is not empty, it will be replaced by the newly created format.
- fileLocation
- The file location flag to indicate where the file is located. Default is Vault.
Legal values:
- Server
- File is located in the server machine. In this case FilePath must be provided.
- Vault
- File is already stored in a vault. In this case vault document URL is mandatory.
- External
- External document. In this case the FilePath must be provided to hold the external file location description.
- URL
- URL external document. In this case the FilePath must be provided to hold file URL value.
- vaultName
- The input vault name. If NULL or empty string, the default vault will be used.
- vaultDocURL
- The input vault document URL (for fileLocation equals "Vault").
- filePath
- The input file path . Used when fileLocation equals "Server".
- hostName
- The host name.
- subMimeType
- The format SubMiteType. Usually the format mimetype is induced from the input file extension (or vault file original file extension). If there exists already a same type of format under the iteration, a SubMimeType must be provided to ensure that the combination of format type and SubMimeType is unique.
- deleteLocalFile
- The flag on whether to delete the local file after it is copied to vault. Only applicable with fileLocation equals "Server". Default is FALSE.
- oDocFormat
- The newly created format.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o CreateNewRevision
public virtual HRESULT CreateNewRevision( | ENOVIDocumentRevision_var& | oNewRev)=0 |
-
Create new revision from this revision.
- Parameters:
-
- oNewRev
- The new revision.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o Delete
-
Delete this revision (all of its iterations are to be deleted). This revision must be the
latest revision. If this revision is the last revision under the document master, the whole
document (including document master) is to be deleted.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o DeleteIteration
public virtual HRESULT DeleteIteration( | CATIVpmFactoryObject_var& | iDocIter)=0 |
-
Delete an iteration. This method automatically deletes all the contents of this iteration (Format,
DocFile, and Vault document).
Warning: this method doesn't not check if the iteration is preferred or not. The caller should either
never use preferred iteration as input, or intentionaly want to delete the preferred iteration.
- Parameters:
-
- iDocIter
- To be deleted iteration.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o Init
-
Initializes a new revision.
- Parameters:
-
- iOldRevision
- The old Revision object
o IsSheet
public virtual HRESULT IsSheet( | boolean& | oIsSheet)=0 |
-
Checks whether this revision is a Sheet.
- Parameters:
-
- oIsSheet
- The result boolean value
o IsTOC
public virtual HRESULT IsTOC( | boolean& | oIsTOC)=0 |
-
Checks whether this revision is a TOC.
- Parameters:
-
- oIsTOC
- The result boolean value
o UpdateFormat
-
Updates a format by given MIMEType.
- Parameters:
-
- iMIMEType
- The MIMEType
- oRecomputedFormat
- The recomputed format
o get_DocIterationCount
public virtual HRESULT get_DocIterationCount( | long& | oNbIterations)=0 |
-
Retrieves the iteration count.
- Parameters:
-
- oNbIterations
- The number of iterations (warning: this number includes the dummy iteration).
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_DocIterations
public virtual HRESULT get_DocIterations( | CATLISTV(CATIVpmFactoryObject_var)& | oDocIterations)=0 |
-
Retrieves all the iterations.
- Parameters:
-
- oDocIterations
- The list of all the iterations. Warning: this list includes the dummy iteration. This list is sorted ascendly by iteration number. The dummy iteration's number is 0.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o get_MIMEType
-
Retrieves primary format MIMEType.
- Parameters:
-
- oTypes
- The list of MIMETypes
o get_PreferredIteration
public virtual HRESULT get_PreferredIteration( | ENOVIDocumentIteration_var& | oDocIter)=0 |
-
Retrieves the preferred iteration.
- Parameters:
-
- oDocIter
- The output preferred iteration. If the dummy iteration is the only iteration, NULL is returned.
- Returns:
- S_OK if successful. S_FALSE if no real iteration (non-dummy iteration) is found.
E_FAIL in case of error.
o get_PrimaryFormat
public virtual HRESULT get_PrimaryFormat( | CATIVpmFactoryObject_var& | oFormat)=0 |
-
Retrieves the primary format of preferred iteration.
- Parameters:
-
- oFormat
- The format object
o get_UpdatedFormats
-
Retrieves updated formats.
- Parameters:
-
- oMIMETypes
- The list of MIMETypes of formats.
- oFormats
- The list of formats object.
o set_MIMEType
-
Sets primary format MIMEType.
- Parameters:
-
- iMIMEType
- The MIMEType
o set_PreferredIteration
public virtual HRESULT set_PreferredIteration( | const ENOVIDocumentIteration_var& | iDocIter)=0 |
-
Set the preferred iteration.
- Parameters:
-
- iDocIter
- The iteration that to be set to preferred.
- Returns:
- S_OK if successful. E_FAIL in case of error.
o set_PrimaryFormat
public virtual HRESULT set_PrimaryFormat( | const ENOVIIterationFormat_var& | iDocFormat)=0 |
-
Set the input format to be primay.
- Parameters:
-
- iDocFormat
- The format that to be set to primary.
- Returns:
- S_OK if successful. E_FAIL in case of error.
This object is included in the file: ENOVIDocumentRevision.h
If needed, your Imakefile.mk should include the module: VX0DDMNG