Package com._1c.g5.v8.dt.core.provider

Interface IBmObjectExporter

All Known Implementing Classes:

BaseBmObjectExporter, CaiBmExporter, CmiExporter, HpwaExporter, ScheduleExporter

public interface IBmObjectExporter

Components responsible for exporting BM objects (or rather object changes) to workspace files. Which files objects are exported to depends on implementations.

Method Summary

Modifier and Type	Method	Description
BmFileDeletionResult	deleteFile(IDtProject project, IBmNamespace namespace, org.eclipse.emf.ecore.EClass eClass, String fqn)	Deletes the file(s) the top object data is saved in as a response to the object's deletion.
BmFileSaveResult	saveFile(IDtProject project, IBmNamespace namespace, long topObjectId)	Exports the specified top object data and saves it in the corresponding workspace file(s) as a response to the object's creation or modification.
boolean	supports(org.eclipse.emf.ecore.EClass eClass)	Checks if the exporter supports objects of the specified EMF class.

Method Detail

supports

boolean supports(org.eclipse.emf.ecore.EClass eClass)

Checks if the exporter supports objects of the specified EMF class.

Parameters:

eClass - The EMF class to check. May not be null.

Returns:

true if the exporter supports the EMF class, false otherwise.

saveFile

BmFileSaveResult saveFile(IDtProject project,
                          IBmNamespace namespace,
                          long topObjectId)
                   throws org.eclipse.core.runtime.CoreException

Exports the specified top object data and saves it in the corresponding workspace file(s) as a response to the object's creation or modification.

Parameters:

project - The project the top object belongs to. May not be null.

namespace - The namespace the top object belongs to. May not be null.

topObjectId - The identifier of the top object.

Returns:

an instance of BmFileSaveResult containing information about the saved file(s).

Throws:

org.eclipse.core.runtime.CoreException - if an error occurs.

deleteFile

BmFileDeletionResult deleteFile(IDtProject project,
                                IBmNamespace namespace,
                                org.eclipse.emf.ecore.EClass eClass,
                                String fqn)
                         throws org.eclipse.core.runtime.CoreException

Deletes the file(s) the top object data is saved in as a response to the object's deletion.

Parameters:

project - The project the top object belongs to. May not be null.

namespace - The namespace the top object belongs to. May not be null.

eClass - The EMF class of the top object. May not be null.

fqn - The FQN of the top object. May not be null.

Returns:

an instance of BmFileDeletionResult containing information about the deleted file(s).

Throws:

org.eclipse.core.runtime.CoreException - if an error occurs.