All Frameworks Class Hierarchy This Framework Indexes
ENOVDDManager Interface ENOVIDocumentIteration
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIDocumentIteration
Interface for ENOVIDocumentIteration.
Role: This interface defines methods on ENOVIDocumentIteration object.
Method Index
- o
AggregateFormat(int,CATUnicodeString&,CATUnicodeString&,boolean&,CATIVpmFactoryObject_var&)
- Create a format object.
- o
AggregateFormat(ENOVIIterationFormat_var&,int,CATUnicodeString&,CATUnicodeString&,boolean&,ENOVIIterationFormat_var&)
- This method creates a new format.
- o
DeleteFormat(CATIVpmFactoryObject_var&)
- Delete the input format and its content (its Vault document and DocFile).
- o
get_DocFile(ENOVIDocumentFile_var&)
- Retrieves the document File under the primary format in this iteration.
- o
get_DocFormatCount(long&)
- Retrieves the count of formats in this iteration.
- o
get_DocFormats(CATLISTV(CATIVpmFactoryObject_var)&)
- Retrieves all the formats in this iteration.
- o
get_PrimaryFormat(ENOVIIterationFormat_var&)
- Retrieves the primary format in this iteration.
- o
get_RevisionFromIteration(CATIAVPMObjectVersion*&)
- Retrieves the revision that this iteration belongs to.
- o
get_RevisionFromIteration(ENOVIDocumentRevision_var&)
- Retrieves the revision that this iteration belongs to.
- o
set_PrimaryFormat(ENOVIIterationFormat_var&)
- Sets the primary format in this iteration.
Methods
o AggregateFormat
| public virtual AggregateFormat( | const | iControlCode, |
| const | iMimeType, |
| const | iSubMimeType, |
| const | iIsURL, |
| | oDocFormat) |
-
Create a format object.
- Parameters:
-
- iControlCode
- The control code
- iMimeType
- The format MIMEType
- iSubMimeType
- The format secondary MIMEType
- iIsURL
- The value of whether document is a URL or not
- oDocFormat
- The created format
o AggregateFormat
| public virtual AggregateFormat( | const | iFormatToBeReplaced, |
| const | iControlcode, |
| const | iMimeType, |
| const | iSubMimeType, |
| const | iIsURL, |
| | oDocFormat) |
-
This method creates a new format. It will replace the input format if the input format is not empty.
- Parameters:
-
- iFormatToBeReplaced
- The input format. If its value is not NULL, then this format will be replaced by the newly created format.
- iControlCode
- The control code (1 for vaulted document. 0 elsewise).
- iMimeType
- The format MIMEType
- iSubMimeType
- The format secondary MIMEType
- iIsURL
- The value of whether document is a URL or not
- oDocFormat
- The created format
- Returns:
- S_OK if successful. E_FAIL if there is an error.
o DeleteFormat
| public virtual DeleteFormat( | | iDocFormat) |
-
Delete the input format and its content (its Vault document and DocFile).
Warning: this method doesn't check if the input format is primary or not. Caller of this method
should either not use primary format as input, or intentionaly delete the primary format.
- Parameters:
-
- iDocFormat
- To be deleted format.
- Returns:
- S_OK if successful. E_FAIL if there is an error.
o get_DocFile
| public virtual get_DocFile( | | oDocFile) |
-
Retrieves the document File under the primary format in this iteration.
- Parameters:
-
- oDocFile
- The returned document file.
- Returns:
- S_OK if successful. E_FAIL if there is an error.
o get_DocFormatCount
| public virtual get_DocFormatCount( | | oNbFormats) |
-
Retrieves the count of formats in this iteration.
- Parameters:
-
- oNbFormats
- The count of format objects
o get_DocFormats
| public virtual get_DocFormats( | | oDocFormats) |
-
Retrieves all the formats in this iteration.
- Parameters:
-
- oDocFormats
- The list of format objects
o get_PrimaryFormat
| public virtual get_PrimaryFormat( | | oPrimaryFormat) |
-
Retrieves the primary format in this iteration.
- Parameters:
-
- oPrimaryFormat
- The primary format object.
- Returns:
- S_OK if successful. E_FAIL if there is an error.
o get_RevisionFromIteration
| public virtual get_RevisionFromIteration( | | oDocRevision) |
-
Retrieves the revision that this iteration belongs to.
- Parameters:
-
- oDocRevision
- The document revision object
o get_RevisionFromIteration
| public virtual get_RevisionFromIteration( | | oDocRevision) |
-
Retrieves the revision that this iteration belongs to.
- Parameters:
-
- oDocRevision
- The document revision object
o set_PrimaryFormat
| public virtual set_PrimaryFormat( | const | iPrimaryFormat) |
-
Sets the primary format in this iteration.
- Parameters:
-
- iPrimaryFormat
- The input format object to be set tp primary format.
- Returns:
- S_OK if successful. E_FAIL if there is an error.
This object is included in the file: ENOVIDocumentIteration.h
If needed, your Imakefile.mk should include the module: VX0DDMNG