Package wt.ixb.publicforhandlers

Interface ClassExporter

All Known Subinterfaces:
ClassExporterImporter
All Known Implementing Classes:
wt.ixb.epm.handlers.forclasses._ExpImpForEPMDocument, wt.associativity.ixb.handlers.forclasses._ExpImpForEquivalenceLink, wt.esi.ixb.handlers.forclasses._ExpImpForERPPartSpecificPlantData, wt.esi.ixb.handlers.forclasses._ExpImpForERPPartSpecificPlantDataLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMCompatibilityLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMDescribeMfgProcessLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMDocumentDescribeLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMDocumentReferenceLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMMfgStandardUsageLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMOperationProcessLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMOperationToConsumableLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMOperationToOperatedPartLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMOperationToPartLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMOperationToWorkCenterLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMOperationUsageLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMPartToPlantAssignmentLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMPartToProcessPlanLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMPlantAssignmentLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMPlantLocalizationLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMPrecedenceConstraintLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMProcessPlanLocalizationLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMSequenceUsageLink, com.ptc.windchill.mpml.ixb.handlers.forclasses._ExpImpForMPMStandardProcedureLink, wt.ixb.handlers.forclasses._ExpImpForWTDocument, wt.ixb.handlers.forclasses._ExpImpForWTDocumentDependencyLink, wt.ixb.handlers.forclasses._ExpImpForWTDocumentUsageLink, ClassExporterImporterTemplate, ClassExporterImporterTemplateGeneral, ExpImpForEPMDocument, ExpImpForEquivalenceLink, ExpImpForERPPartSpecificPlantData, ExpImpForERPPartSpecificPlantDataLink, ExpImpForLinkObject, ExpImpForMPMCompatibilityLink, ExpImpForMPMDescribeMfgProcessLink, ExpImpForMPMDocumentDescribeLink, ExpImpForMPMDocumentReferenceLink, ExpImpForMPMMfgStandardUsageLink, ExpImpForMPMOperationProcessLink, ExpImpForMPMOperationToConsumableLink, ExpImpForMPMOperationToOperatedPartLink, ExpImpForMPMOperationToPartLink, ExpImpForMPMOperationToWorkCenterLink, ExpImpForMPMOperationUsageLink, ExpImpForMPMPartToPlantAssignmentLink, ExpImpForMPMPartToProcessPlanLink, ExpImpForMPMPlantAssignmentLink, ExpImpForMPMPlantLocalizationLink, ExpImpForMPMPrecedenceConstraintLink, ExpImpForMPMProcessPlanLocalizationLink, ExpImpForMPMSequenceUsageLink, ExpImpForMPMStandardProcedureLink, ExpImpForVersionedObject, ExpImpForWTDocument, ExpImpForWTDocumentDependencyLink, ExpImpForWTDocumentUsageLink
public interface ClassExporter
Interface for all class handrlers for export.

Supported API: true

Extendable: false

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    NO_PRIORITY
    The default priority / No specific priority.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    exportObject(Object ob, Exporter exporter)
    Exports the specified object in context given by parameter exporter.
    void
    finalizeExport(Exporter exporter)
    This method is called in the end of the whole export process to execute any additional export process finalization.
    int
    getAdditionalExportPriority(Object ob)
    Return the additional export priority based on the object, supplemented to getExportPriority().
    int
    getExportPriority()
    Return the export priority of the object type represented by this export handler.

  • Field Details

    • NO_PRIORITY

      static final int NO_PRIORITY
      The default priority / No specific priority. The value returned is zero.

      Supported API: true
      See Also:

  • Method Details

    • exportObject

      void exportObject(Object ob, Exporter exporter) throws WTException
      Exports the specified object in context given by parameter exporter.

      Supported API: true
      Parameters:
      ob - The object to be exported.
      exporter - The Exporter instance that represents the context of the export operation.
      Throws:
      WTException

    • finalizeExport

      void finalizeExport(Exporter exporter) throws WTException
      This method is called in the end of the whole export process to execute any additional export process finalization.

      Supported API: true
      Parameters:
      exporter - Exports the specified object in context given by parameter exporter.
      Throws:
      WTException

    • getExportPriority

      int getExportPriority() throws WTException
      Return the export priority of the object type represented by this export handler.
      Export priority defines the order in which objects will be exported. This method does not carry parameters in the signature. The return value can not be negative. Those object will have a higher export priority for smaller returned values. This complements ElementImporter.getImportPriority()

      Supported API: true
      Returns:
      int
      Throws:
      WTException

    • getAdditionalExportPriority

      int getAdditionalExportPriority(Object ob) throws WTException
      Return the additional export priority based on the object, supplemented to getExportPriority().
    • NOTE: Override hasAdditionalExportPriority() to return true before overriding this method.
    • The returned number defines the order in which the object will be exported if getExportPriority() returns the same value. In general, if getExportPriority() returns a smaller value, it will have a higher export priority; for the object with the same value of getExportPriority(), the one with a smaller value from this method will have a higher export priority.The returned value must be at least 0. This complements ElementImporter.getAdditionalImportPriority(IxbElement)

      Supported API: true
      • Parameters:
      ob - The object whose additional export priority is to be determined.
      Returns:
      int The additional export priority of the object.
      Throws:
      WTException