Interface IModelApi

All Known Subinterfaces:
IEditingContext
All Known Implementing Classes:
AbstractBmModelApi, AbstractModelApi, BmEditingContext, BmModelApi, BmModelReadonlyApi, CmiExtensionEditingContext, EmfEditingContext, ProjectOperationWrappingEditingContext, ProjectOperationWrappingModelApi

public interface IModelApi
The API that performs high-level data manipulations for the model (EMF/BM) objects.
  • Method Summary

    Modifier and Type
    Method
    Description
    <T> T
    execute(long[] bmObjectIds, IModelApiTaskN<T> task, org.eclipse.core.runtime.IProgressMonitor monitor)
    Executes the specified task.
    <T, E extends org.eclipse.emf.ecore.EObject>
    T
    execute(long bmObjectId, IModelApiTask<T,E> task, org.eclipse.core.runtime.IProgressMonitor monitor)
    Executes the specified task.
    <T> T
    execute(IBmTask<T> task, org.eclipse.core.runtime.IProgressMonitor monitor)
    Executes the specified task.
    <T, E1 extends org.eclipse.emf.ecore.EObject, E2 extends org.eclipse.emf.ecore.EObject>
    T
    execute(E1 object1, E2 object2, IModelApiTask2<T,E1,E2> task, org.eclipse.core.runtime.IProgressMonitor monitor)
    Executes the specified task.
    <T, E1 extends org.eclipse.emf.ecore.EObject, E2 extends org.eclipse.emf.ecore.EObject, E3 extends org.eclipse.emf.ecore.EObject>
    T
    execute(E1 object1, E2 object2, E3 object3, IModelApiTask3<T,E1,E2,E3> task, org.eclipse.core.runtime.IProgressMonitor monitor)
    Executes the specified task.
    <T, E extends org.eclipse.emf.ecore.EObject>
    T
    execute(E object, IModelApiTask<T,E> task, org.eclipse.core.runtime.IProgressMonitor monitor)
    Executes the specified task.
    <T> T
    execute(Collection<org.eclipse.emf.ecore.EObject> objects, IModelApiTaskN<T> task, org.eclipse.core.runtime.IProgressMonitor monitor)
    Executes the specified task.
  • Method Details

    • execute

      <T> T execute(IBmTask<T> task, org.eclipse.core.runtime.IProgressMonitor monitor)
      Executes the specified task.
      Type Parameters:
      T - the type of the task result.
      Parameters:
      task - the BM task to execute, cannot be null.
      monitor - the progress monitor, cannot be null.
      Returns:
      the result returned by IBmTask.execute(IBmTransaction, IProgressMonitor) method.
    • execute

      <T, E extends org.eclipse.emf.ecore.EObject> T execute(long bmObjectId, IModelApiTask<T,E> task, org.eclipse.core.runtime.IProgressMonitor monitor)
      Executes the specified task.
      Type Parameters:
      T - the type of the task result.
      E - the object type.
      Parameters:
      bmObjectId - the identifier of the BM object that is being an argument for the specified task.
      task - the task to execute, cannot be null.
      monitor - the progress monitor, cannot be null.
      Returns:
      the result returned by IBmTask.execute(IBmTransaction, IProgressMonitor) method.
    • execute

      <T> T execute(long[] bmObjectIds, IModelApiTaskN<T> task, org.eclipse.core.runtime.IProgressMonitor monitor)
      Executes the specified task.
      Type Parameters:
      T - the type of the task result.
      E - the object type.
      Parameters:
      bmObjectIds - the identifiers of the BM objects that are being an arguments for the specified task.
      task - the task to execute, cannot be null.
      monitor - the progress monitor, cannot be null.
      Returns:
      the result returned by IBmTask.execute(IBmTransaction, IProgressMonitor) method.
    • execute

      <T, E extends org.eclipse.emf.ecore.EObject> T execute(E object, IModelApiTask<T,E> task, org.eclipse.core.runtime.IProgressMonitor monitor)
      Executes the specified task.
      Type Parameters:
      T - the type of the task result.
      E - the object type.
      Parameters:
      object - the object that is being an argument for the specified task.
      task - the task to execute, cannot be null.
      monitor - the progress monitor, cannot be null.
      Returns:
      the result returned by IBmTask.execute(IBmTransaction, IProgressMonitor) method.
    • execute

      <T, E1 extends org.eclipse.emf.ecore.EObject, E2 extends org.eclipse.emf.ecore.EObject> T execute(E1 object1, E2 object2, IModelApiTask2<T,E1,E2> task, org.eclipse.core.runtime.IProgressMonitor monitor)
      Executes the specified task.
      Type Parameters:
      T - the type of the task result.
      E1 - the first object type.
      E2 - the second object type.
      Parameters:
      object1 - the object that is being the first argument for the specified task.
      object2 - the object that is being the second argument for the specified task.
      task - the task to execute, cannot be null.
      monitor - the progress monitor, cannot be null.
      Returns:
      the result returned by IBmTask.execute(IBmTransaction, IProgressMonitor) method.
    • execute

      <T, E1 extends org.eclipse.emf.ecore.EObject, E2 extends org.eclipse.emf.ecore.EObject, E3 extends org.eclipse.emf.ecore.EObject> T execute(E1 object1, E2 object2, E3 object3, IModelApiTask3<T,E1,E2,E3> task, org.eclipse.core.runtime.IProgressMonitor monitor)
      Executes the specified task.
      Type Parameters:
      T - the type of the task result.
      E1 - the first object type.
      E2 - the second object type.
      E3 - the third object type.
      Parameters:
      object1 - the object that is being the first argument for the specified task.
      object2 - the object that is being the second argument for the specified task.
      object3 - the object that is being the third argument for the specified task.
      task - the task to execute, cannot be null.
      monitor - the progress monitor, cannot be null.
      Returns:
      the result returned by IBmTask.execute(IBmTransaction, IProgressMonitor) method.
    • execute

      <T> T execute(Collection<org.eclipse.emf.ecore.EObject> objects, IModelApiTaskN<T> task, org.eclipse.core.runtime.IProgressMonitor monitor)
      Executes the specified task.
      Type Parameters:
      T - the type of the task result.
      E - the object type.
      Parameters:
      objects - the objects that are being an arguments for the specified task.
      task - the task to execute, cannot be null.
      monitor - the progress monitor, cannot be null.
      Returns:
      the result returned by IBmTask.execute(IBmTransaction, IProgressMonitor) method.