Package wt.ixb.actor

Interface Actor

All Known Implementing Classes:
ActorTemplate, wt.ixb.actor.ActorTemplateForPersistable, ActorTemplateForTypeDefinition, wt.ixb.actor.ActorTemplateForVersioned, CheckOutActorTemplate, CheckOutFTActorTemplate, NewIterationWhenNotExistActorForVersioned
public interface Actor
This interface represents various actions on export and import. The actions can be explicitly specified from client or from server registry.

Supported API: true

Extendable: false

  • Method Details

    • performPreExportAction

      void performPreExportAction(ClassExporterImporter handler, Exporter exporter, Object object) throws WTException
      Perform any actions for the object before the real export begins. Usually this method does nothing.

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

    • performPostExportAction

      void performPostExportAction(ClassExporterImporter handler, Exporter exporter, Object object, IxbElement fileXML) throws WTException
      Perform any action for the object after the real export ends. Usually all common export actions are executed here.

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

    • previewObject

      void previewObject(ClassExporterImporter handler, IxbElement fileXML, Importer importer) throws WTException
      Preview the import, including conflicts checking, without performing the real import.

      Supported API: true
      Parameters:
      handler - The import class handler for the corresponding XML file.
      fileXML - the XML element to be imported.
      importer - The Importer instance that represents the context of the import operation.
      Throws:
      WTException

    • createObject

      Object createObject(ClassExporterImporter handler, IxbElement fileXML, Importer importer) throws WTException
      Create an object instance. Usually the instance will not be persisted within this method context.

      Supported API: true
      Parameters:
      handler - The import class handler for the corresponding XML file.
      fileXML - the XML element to be imported.
      importer - The Importer instance that represents the context of the import operation.
      Returns:
      Object
      Throws:
      WTException
      See Also:
      • method storeObject( ClassExporterImporter handler, Object object, IxbElement fileXML, Importer importer )

    • storeObject

      Object storeObject(ClassExporterImporter handler, Object object, IxbElement fileXML, Importer importer) throws WTException
      Persists the specified object as created by createObject(ClassExporterImporter handler, IxbElement fileXML, Importer importer)

      Supported API: true
      Parameters:
      handler - The import class handler for the corresponding XML file.
      object - The object to be persisted.
      fileXML - the XML element to be imported.
      importer - The Importer instance that represents the context of the import operation.
      Returns:
      Object
      Throws:
      WTException

    • checkApplicabilityOfAction

      void checkApplicabilityOfAction(Object obj) throws WTException
      Check if this action is applicable to the specified object. If not, throw wt.util.WTException

      Supported API: true
      Parameters:
      obj -
      Throws:
      WTException

    • checkConflicts

      void checkConflicts(ClassExporterImporter handler, IxbElement elem, Importer importer) throws WTException
      Checks conflicts that can arise while import process.

      Supported API: true
      Parameters:
      elem - the XML element to be imported.
      importer - The Importer instance that represents the context of the import operation.
      Throws:
      WTException