Package de.mid.innovator.m2msdk.model.progress

Interface ProgressModelInterface

All Superinterfaces:
Remote, Serializable
All Known Implementing Classes:
ProgressModel, ProgressModelSkeleton, ProgressModelStub
public interface ProgressModelInterface extends Serializable, Remote
Interface for progress model.
Version:
10.1.1
Author:
jmback

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    elementAdvance()
    Advance the element counter
    ConfigurationItemIF
    getCurrentConfigurationItem()
    Get the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.
    ProgressInfo
    getCurrentElement()
    gets the current processed model element.
    org.jdom2.Document
    getDocument()
    Get content of progress model as a document.
    ProgressStep
    getModelElement()
    Get number of model elements treated in the current progress step and number of current model element.
    ProgressStep
    getStep()
    Get the number of progress steps to be executed and number of current progress step.
    boolean
    isClientWaiting()
    The progress model is waiting for new information from engine.
    boolean
    isStarted()
    Has the progress model already started? Only for a started progress model a progress dialog is shown.
    void
    reset()
    Resets the ProgressModel.
    void
    setClientWaiting(boolean bWaiting)
    Tell the progress model, whether the progress client is waiting on new information from server engine.
    void
    setCurrentConfigurationItem(ConfigurationItemIF iItem)
    Set the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.
    void
    setCurrentElement(ProgressInfo iInfo)
    Set the current element.
    void
    setNumModelElements(int numModelElements)
    Set number of model elements treated in the current progress step.
    void
    setNumSteps(int numSteps)
    Set number of model transformation steps to be executed.
    void
    setStarted(boolean started)
    Set to true, if the progress model already has started.
    void
    stepAdvance()
    Advance the step counter
    void
    stepInto()
    Continue processing until the next of the son type.
    void
    stepOut()
    Continue processing until the next of the parent type.
    void
    stepOver()
    Continue processing until the next of the same type.

  • Method Details

    • isStarted

      boolean isStarted() throws RemoteException
      Has the progress model already started? Only for a started progress model a progress dialog is shown.
      Returns:
      True if progress model has started
      Throws:
      RemoteException - communication error

    • setStarted

      void setStarted(boolean started) throws RemoteException
      Set to true, if the progress model already has started.
      Parameters:
      started - True if progress model has started
      Throws:
      RemoteException - communication error

    • isClientWaiting

      boolean isClientWaiting() throws M2MException, RemoteException
      The progress model is waiting for new information from engine. This is for synchronization of progress client and server engine.
      Returns:
      true, if the progress client is waiting for new information.
      Throws:
      M2MException
      RemoteException

    • setClientWaiting

      void setClientWaiting(boolean bWaiting) throws M2MException, RemoteException
      Tell the progress model, whether the progress client is waiting on new information from server engine. This is for synchronization of progress client and server engine.
      Parameters:
      bWaiting - true, if the progress client is waiting for new information.
      Throws:
      M2MException
      RemoteException

    • getStep

      ProgressStep getStep() throws RemoteException
      Get the number of progress steps to be executed and number of current progress step.
      Returns:
      relative number of steps
      Throws:
      RemoteException - communication error

    • setNumSteps

      void setNumSteps(int numSteps) throws RemoteException
      Set number of model transformation steps to be executed.
      Parameters:
      numSteps - Number of steps
      Throws:
      RemoteException - communication error

    • getModelElement

      ProgressStep getModelElement() throws RemoteException
      Get number of model elements treated in the current progress step and number of current model element.
      Returns:
      relative number of model elements
      Throws:
      RemoteException - communication error

    • setNumModelElements

      void setNumModelElements(int numModelElements) throws RemoteException
      Set number of model elements treated in the current progress step.
      Parameters:
      numModelElements - Number of model elements
      Throws:
      RemoteException - communication error

    • setCurrentElement

      void setCurrentElement(ProgressInfo iInfo) throws M2MException, RemoteException
      Set the current element.
      Parameters:
      iInfo - Next element
      Throws:
      M2MException
      RemoteException

    • getCurrentElement

      ProgressInfo getCurrentElement() throws M2MException, RemoteException
      gets the current processed model element.
      Returns:
      currently processed element
      Throws:
      M2MException
      RemoteException

    • getCurrentConfigurationItem

      ConfigurationItemIF getCurrentConfigurationItem() throws M2MException, RemoteException
      Get the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.
      Returns:
      underlying configuration item
      Throws:
      M2MException
      RemoteException

    • setCurrentConfigurationItem

      void setCurrentConfigurationItem(ConfigurationItemIF iItem) throws M2MException, RemoteException
      Set the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.
      Parameters:
      iItem - underlying configuration item
      Throws:
      M2MException
      RemoteException

    • reset

      void reset() throws RemoteException
      Resets the ProgressModel.
      Throws:
      RemoteException - communication error

    • stepOver

      void stepOver() throws RemoteException
      Continue processing until the next of the same type.
      Throws:
      RemoteException - communication error

    • stepOut

      void stepOut() throws RemoteException
      Continue processing until the next of the parent type.
      Throws:
      RemoteException - communication error

    • stepInto

      void stepInto() throws RemoteException
      Continue processing until the next of the son type.
      Throws:
      RemoteException - communication error

    • getDocument

      org.jdom2.Document getDocument() throws M2MException, RemoteException
      Get content of progress model as a document.
      Returns:
      XML document containing the content of the progress model
      Throws:
      SevereException
      M2MException
      RemoteException

    • stepAdvance

      void stepAdvance()
      Advance the step counter

    • elementAdvance

      void elementAdvance()
      Advance the element counter