Class ProgressModelStub
java.lang.Object
de.mid.innovator.m2msdk.model.progress.ProgressModelStub
- All Implemented Interfaces:
ProgressModelInterface,Serializable,Remote
Stub class living on client side and always forwarding the calls to the server.
- Version:
- 11.3.1
- Author:
- jmback
- See Also:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdvance the element counterGet the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.gets the current processed model element.org.jdom2.DocumentGet content of progress model as a document.Get number of model elements treated in the current progress step and number of current model element.getStep()Get the number of progress steps to be executed and number of current progress step.booleanThe progress model is waiting for new information from engine.booleanHas the progress model already started? Only for a started progress model a progress dialog is shown.voidreset()Resets the ProgressModel.voidsetClientWaiting(boolean waiting) Tell the progress model, whether the progress client is waiting on new information from server engine.voidSet the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.voidsetCurrentElement(ProgressInfo iInfo) Set the current element.voidsetNumModelElements(int numModelElements) Set number of model elements treated in the current progress step.voidsetNumSteps(int numSteps) Set number of model transformation steps to be executed.voidsetStarted(boolean started) Set to true, if the progress model already has started.voidAdvance the step countervoidstepInto()Continue processing until the next of the son type.voidstepOut()Continue processing until the next of the parent type.voidstepOver()Continue processing until the next of the same type.
-
Constructor Details
-
ProgressModelStub
-
-
Method Details
-
setCurrentElement
Description copied from interface:ProgressModelInterfaceSet the current element.- Specified by:
setCurrentElementin interfaceProgressModelInterface- Parameters:
iInfo- Next element- Throws:
M2MException
-
getCurrentElement
Description copied from interface:ProgressModelInterfacegets the current processed model element.- Specified by:
getCurrentElementin interfaceProgressModelInterface- Returns:
- currently processed element
- Throws:
M2MExceptionRemoteException
-
getModelElement
Description copied from interface:ProgressModelInterfaceGet number of model elements treated in the current progress step and number of current model element.- Specified by:
getModelElementin interfaceProgressModelInterface- Returns:
- relative number of model elements
- Throws:
RemoteException- communication error
-
getStep
Description copied from interface:ProgressModelInterfaceGet the number of progress steps to be executed and number of current progress step.- Specified by:
getStepin interfaceProgressModelInterface- Returns:
- relative number of steps
- Throws:
RemoteException- communication error
-
isStarted
Description copied from interface:ProgressModelInterfaceHas the progress model already started? Only for a started progress model a progress dialog is shown.- Specified by:
isStartedin interfaceProgressModelInterface- Returns:
- True if progress model has started
- Throws:
RemoteException- communication error
-
reset
Description copied from interface:ProgressModelInterfaceResets the ProgressModel.- Specified by:
resetin interfaceProgressModelInterface- Throws:
RemoteException- communication error
-
setNumModelElements
Description copied from interface:ProgressModelInterfaceSet number of model elements treated in the current progress step.- Specified by:
setNumModelElementsin interfaceProgressModelInterface- Parameters:
numModelElements- Number of model elements- Throws:
RemoteException- communication error
-
setNumSteps
Description copied from interface:ProgressModelInterfaceSet number of model transformation steps to be executed.- Specified by:
setNumStepsin interfaceProgressModelInterface- Parameters:
numSteps- Number of steps- Throws:
RemoteException- communication error
-
setStarted
Description copied from interface:ProgressModelInterfaceSet to true, if the progress model already has started.- Specified by:
setStartedin interfaceProgressModelInterface- Parameters:
started- True if progress model has started- Throws:
RemoteException- communication error
-
stepInto
Description copied from interface:ProgressModelInterfaceContinue processing until the next of the son type.- Specified by:
stepIntoin interfaceProgressModelInterface- Throws:
RemoteException- communication error
-
stepOut
Description copied from interface:ProgressModelInterfaceContinue processing until the next of the parent type.- Specified by:
stepOutin interfaceProgressModelInterface- Throws:
RemoteException- communication error
-
stepOver
Description copied from interface:ProgressModelInterfaceContinue processing until the next of the same type.- Specified by:
stepOverin interfaceProgressModelInterface- Throws:
RemoteException- communication error
-
getCurrentConfigurationItem
Description copied from interface:ProgressModelInterfaceGet the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.- Specified by:
getCurrentConfigurationItemin interfaceProgressModelInterface- Returns:
- underlying configuration item
- Throws:
M2MExceptionRemoteException
-
setCurrentConfigurationItem
public void setCurrentConfigurationItem(ConfigurationItemIF iItem) throws M2MException, RemoteException Description copied from interface:ProgressModelInterfaceSet the configuration item in model transformation configuration from which the configurable item is currently executed in the current model transformation.- Specified by:
setCurrentConfigurationItemin interfaceProgressModelInterface- Parameters:
iItem- underlying configuration item- Throws:
M2MExceptionRemoteException
-
isClientWaiting
Description copied from interface:ProgressModelInterfaceThe progress model is waiting for new information from engine. This is for synchronization of progress client and server engine.- Specified by:
isClientWaitingin interfaceProgressModelInterface- Returns:
- true, if the progress client is waiting for new information.
- Throws:
M2MExceptionRemoteException
-
setClientWaiting
Description copied from interface:ProgressModelInterfaceTell 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.- Specified by:
setClientWaitingin interfaceProgressModelInterface- Parameters:
waiting- true, if the progress client is waiting for new information.- Throws:
M2MExceptionRemoteException
-
getDocument
Description copied from interface:ProgressModelInterfaceGet content of progress model as a document.- Specified by:
getDocumentin interfaceProgressModelInterface- Returns:
- XML document containing the content of the progress model
- Throws:
M2MExceptionRemoteException
-
stepAdvance
public void stepAdvance()Description copied from interface:ProgressModelInterfaceAdvance the step counter- Specified by:
stepAdvancein interfaceProgressModelInterface
-
elementAdvance
public void elementAdvance()Description copied from interface:ProgressModelInterfaceAdvance the element counter- Specified by:
elementAdvancein interfaceProgressModelInterface
-