IModelingSession (Modelio 4.1 API (commercial))

```
public interface IModelingSession
```
This interface represents a project session. A modeling session is used to update a modelio project and to give the right model navigation roots.

The current modeling session can be accessed using the following API: IModelingSession session = Modelio.getInstance().getModelingSession();

The IModelingSession interface groups the following features:
- Transaction management
- Model change management
- Model root access
- MObject status management

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addModelHandler(IModelChangeHandler handler)` Add a model change listener.
`void`	`addModelListener(IModelChangeListener listener)` Add a model change handler.
`void`	`addStatusListener(IStatusChangeListener listener)` Add a status handler.
`ITransaction`	`createTransaction(java.lang.String transactionName)` Create a new transaction in the project.
`<T extends MObject> java.util.Collection<T>`	`findByAtt(java.lang.Class<T> metaclass, java.lang.String att, java.lang.String value)` Get elements in the model from a metaclass, a meta attribute name and its value.
`java.util.Collection<? extends MObject>`	`findByAtt(MClass metaclass, java.lang.String att, java.lang.String value)` Get elements in the model from a metaclass, a meta attribute name and its value.
`<T extends MObject> java.util.Collection<T>`	`findByClass(java.lang.Class<T> metaclass)` Get all elements in the model from their metaclass.
`java.util.Collection<? extends MObject>`	`findByClass(MClass metaclass)` Get all elements in the model from their metaclass.
`MObject`	`findByRef(MRef ref)` Get an element in the model from an `MRef`.
`<T extends MObject> T`	`findElementById(java.lang.Class<T> metaclass, java.lang.String id)` Get an element in the model from its id and metaclass.
`MObject`	`findElementById(MClass metaclass, java.lang.String id)` Get an element in the model from its id and metaclass.
`IMetamodelExtensions`	`getMetamodelExtensions()` Returns the metamodel extension of the project.
`IUmlModel`	`getModel()` Returns the UML Model of the project.
`java.lang.String`	`getName()` Get the name of this session.
`void`	`getRequirementModel()` Deprecated. replace with `IModelioServices#getService(IAnalystModel.class)` instead to get a proper way to manipulate Requirement model
`void`	`removeModelHandler(IModelChangeHandler handler)` Remove a model change handler.
`void`	`removeModelListener(IModelChangeListener listener)` Remove a model change listener.
`void`	`removeStatusListener(IStatusChangeListener listener)` Remove a status change listener.

- Method Detail
  - addModelHandler
```
void addModelHandler(IModelChangeHandler handler)
```
    Add a model change listener.
    Handlers can modify the model.
    This model listener is used to be notified of the model structural changes, through the use of the IModelChangeHandler listener class.
    
    Parameters:
    
    handler - the model change listener to add.
  - addModelListener
```
void addModelListener(IModelChangeListener listener)
```
    Add a model change handler.
    Added listeners must not modify the model. If model modifications should be done use addModelHandler() method.
    This model listener is used to be notified of the model structural changes, through the use of the IModelChangeListener listener class.
    
    Parameters:
    
    listener - the model change listener to add.
  - addStatusListener
```
void addStatusListener(IStatusChangeListener listener)
```
    Add a status handler.
    Added listeners must not modify the model. If model modifications should be done use addModelHandler() method.
    This model listener is used to be notified of all the model status changes (read/write), through the use of the IStatusChangeListener listener class.
    
    Parameters:
    
    listener - the model change listener to add.
  - createTransaction
```
ITransaction createTransaction(java.lang.String transactionName)
```
    Create a new transaction in the project.
    
    All the model updates have to be carried out in the context of a transaction, which has to be created, through the use of this method, and Committed via the ITransaction.commit() method or rollbacked using the ITransaction.rollback() method.
    
    Parameters:
    
    transactionName - A transaction name. This name is just a label that might be displayed in log files, a console or dialog boxes.
    
    Returns:
    
    the created transaction.
  - findByAtt
```
<T extends MObject> java.util.Collection<T> findByAtt(java.lang.Class<T> metaclass,
                                                      java.lang.String att,
                                                      java.lang.String value)
```
    Get elements in the model from a metaclass, a meta attribute name and its value.
    If Element is given, every elements in the model will be checked.
    
    Parameters:
    
    metaclass - the java interface of the metaclass to look for.
    
    att - the name of the meta attribute to check the value in.
    
    value - the value to look for in the attribute.
    
    Returns:
    
    A collection of elements matching the parameters. Might be empty but never null.
  - findByAtt
```
java.util.Collection<? extends MObject> findByAtt(MClass metaclass,
                                                  java.lang.String att,
                                                  java.lang.String value)
```
    Get elements in the model from a metaclass, a meta attribute name and its value.
    If Element is given, every elements in the model will be checked.
    
    Parameters:
    
    metaclass - the metaclass to look for.
    
    att - the name of the meta attribute to check the value in.
    
    value - the value to look for in the attribute.
    
    Returns:
    
    A collection of elements matching the parameters. Might be empty but never null.
  - findByClass
```
<T extends MObject> java.util.Collection<T> findByClass(java.lang.Class<T> metaclass)
```
    Get all elements in the model from their metaclass.
    
    Parameters:
    
    metaclass - the java interface of the metaclass to look for.
    
    Returns:
    
    A list of all model elements, or null if no match is found.
  - findByClass
```
java.util.Collection<? extends MObject> findByClass(MClass metaclass)
```
    Get all elements in the model from their metaclass.
    
    Parameters:
    
    metaclass - the metaclass to look for.
    
    Returns:
    
    A list of all model elements, or null if no match is found.
  - findElementById
```
<T extends MObject> T findElementById(java.lang.Class<T> metaclass,
                                      java.lang.String id)
```
    Get an element in the model from its id and metaclass.
    
    Parameters:
    
    metaclass - the java interface of the metaclass to look for.
    
    id - the id to look for.
    
    Returns:
    
    A model element, or null if no match is found.
  - findElementById
```
MObject findElementById(MClass metaclass,
                        java.lang.String id)
```
    Get an element in the model from its id and metaclass.
    
    Parameters:
    
    metaclass - the metaclass to look for.
    
    id - the element's id.
    
    Returns:
    
    A model element, or null if no match is found.
  - getMetamodelExtensions
```
IMetamodelExtensions getMetamodelExtensions()
```
    Returns the metamodel extension of the project.
    
    The metamodel extensions are added by the tool when modules are deployed. It corresponds to the stereotypes, note types and tag types brought by modules.
    
    Returns:
    
    the stereotypes, tag types and not types brought by deployed modules.
  - getModel
```
IUmlModel getModel()
```
    Returns the UML Model of the project.
    
    This method is often used to get the roots using the IUmlModel.getModelRoots() method
    
    Returns:
    
    the UML Model connected to the session.
  - getName
```
java.lang.String getName()
```
    Get the name of this session.
    
    Returns:
    
    the name of this session.
  - getRequirementModel
```
@Deprecated
void getRequirementModel()
```
    Deprecated. replace with IModelioServices#getService(IAnalystModel.class) instead to get a proper way to manipulate Requirement model
    
    Used to returns the Requirement Model of the project.
  - removeModelHandler
```
void removeModelHandler(IModelChangeHandler handler)
```
    Remove a model change handler.
    
    Parameters:
    
    handler - the model change handler to remove.
  - removeModelListener
```
void removeModelListener(IModelChangeListener listener)
```
    Remove a model change listener.
    
    Parameters:
    
    listener - the model change listener to remove.
  - removeStatusListener
```
void removeStatusListener(IStatusChangeListener listener)
```
    Remove a status change listener.
    
    Parameters:
    
    listener - the status change listener to remove.
  - findByRef
```
MObject findByRef(MRef ref)
```
    Get an element in the model from an MRef.
    
    Parameters:
    
    ref - a model object reference.
    
    Returns:
    
    A model element, or null if no match is found.
    
    Since:
    
    3.7

Interface IModelingSession

Method Summary

Method Detail

addModelHandler

addModelListener

addStatusListener

createTransaction

findByAtt

findByAtt

findByClass

findByClass

findElementById

findElementById

getMetamodelExtensions

getModel

getName

getRequirementModel

removeModelHandler

removeModelListener

removeStatusListener

findByRef