PublishDocument
Description
The implementation of ISPAdapter7.PublishDocument does the following:
-
Collects all data associated with the specified document.
-
Uses the schema component to create objects and relationships.
-
Adds created objects and relationships to the document data container (passed as an input argument).
-
Checks the value of bViewFileRequired. If it is true, adds the graphic file interfaces to the document metadata container (passed as an input argument). A file object must be created for each view file and reference file for the publishing document. The adapter needs to create the necessary view file interfaces and relationships in the metadata container and set the FilePath property.
-
Returns the type of publish.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocumentIObj |
IObject |
Input |
IObject interface on the document object. |
|
oDocContIContainer |
IContainer |
Input/Output |
Document container. |
|
oDocMetaIContainer |
IContainer |
Input/Output |
Document metadata container. |
|
oDocTombstonesIContainer |
IContainer |
Input/Output |
IContainer pointer to instruction objects published in the context of the document. |
|
bViewFileRequired |
Boolean |
Input |
Indicates whether view files and the reference files need to be added to the metadata container. True is passed for normal publish operations. False is passed in cases where view files and reference files are not required. The case for False would be when only the XML is required. |
|
eptPublishType |
ePublishTypes |
Output |
ePublishTypes.Full indicates that this is a full publish, which is needed for SDx publishing. |
Arguments (Overloaded)
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocumentIObj |
IObject |
Input |
IObject interface on the document object. |
|
oDocContIContainer |
IContainer |
Input/Output |
Document container. |
|
oDocMetaIContainer |
IContainer |
Input/Output |
Document metadata container. |
|
oDocTombstonesIContainer |
IContainer |
Input/Output |
IContainer pointer to instruction objects published in the context of the document. |
|
bViewFileRequired |
Boolean |
Input |
Indicates whether view files and the reference files need to be added to the metadata container. True is passed for normal publish operations. False is passed in cases where view files and reference files are not required. The case for False would be when only the XML is required. |
|
eptPublishType |
ePublishTypes |
Output |
ePublishTypes.Full indicates that this is a full publish, which is needed for SDx publishing. |
|
oMapSchContIContainer |
IContainer |
Input |
Map schema container. This argument is passed only for the tools that support mapping schema. |
Return Value
None.
Comments
If the method fails, the tool will raise an error.
GetPublishCount
For publishing with Integration for SDx, this method should return 1.
Arguments
|
Name |
Data type |
Input/output |
Description |
|---|---|---|---|
|
oDocumentIObj |
IObject |
Input |
IObject interface on the document object. |
|
eptPublishType |
ePublishTypes |
Input |
Should be ePublishTypes.Full to indicate that this is a full publish, which is needed for SDx sharing. |
Return Value
Long. Number of publishes for the document.
Comments
If the method fails, the tool will raise an error.