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. ePublishTypes.Delta indicates that this is a Delta Publish update publish. |
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. ePublishTypes.Delta indicates that this is a Delta Publish update publish. |
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
Depending on the user selection for publish type (All or Changes Only, also called Delta) in the Publish dialog box, the tool determines the number of times the PublishDocument needs to be called for a document. The ISPCLServiceManager calls the method ISPAdapter7.PublishCount to get the count of publishes for a document.
The tool adapter implements the GetPublishCount method to do the following:
-
Determines the type of publish (All or Changes Only) by reading the input argument.
-
Determine the number of publishes for the document. This number depends on the size of data that tool will publish in each publish. This number is obtained by dividing the total number of objects to be published by the number of objects published in each PublishDocument call.
-
Returns the number obtained from step 2
Arguments
Name |
Data type |
Input/output |
Description |
---|---|---|---|
oDocumentIObj |
IObject |
Input |
IObject interface on the document object. |
eptPublishType |
ePublishTypes |
Input |
ePublishTypes.Full indicates that this is a full publish. ePublishTypes.Delta indicates that this is a Delta Publish update publish. |
Return Value
Long. Number of publishes for the document.
Comments
If the method fails, the tool will raise an error.