ICmsServices (Modelio 5.3 API (commercial))

```
public interface ICmsServices
```
Communication interface for other modules to interact with the Subversion module.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addCodeReverser(ICodeReverser reverser)` Add a code reverser that will be called before committing elements.
`IAddCommand`	`createAddCommand()` Create a "Add to version" command.
`IBreakLockCommand`	`createBreakLockCommand()` Create a "Break lock" command.
`ICancelAddCommand`	`createCancelAddCommand()` Create a "Cancel Add" command.
`ICleanupWorkingCopyCommand`	`createCleanUpCommand()` Create a command that Cleanup and repair the working copy.
`ICommitCommand`	`createCommitCommand()` Create a command to commit the elements in subversion and put the CMS lock on them so that they cannot be modified again.
`IConnectDirToRepositoryCommand`	`createConnectDirToRepositoryCommand()` Create a command to checkout a repository directory into a working copy.
`ICreateBranchCommand`	`createCreateBranchCommand()` Create a command to create a branch.
`ICreateTagCommand`	`createCreateTagCommand()` Create a command to create a tag.
`IGetLockCommand`	`createGetLockCommand()` Create a "Get lock" command.
`IMergeCommand`	`createMergeCommand()` Creates a merge command.
`IRemoveCommand`	`createRemoveCommand()`
`IRepairCommand`	`createRepairCommand(IGModelFragment fragment)` Create a repository repair command.
`IRevertCommand`	`createRevertCommand()` Create a "Revert" command.
`ISymbolService`	`createSymbolService()` Create a symbol service.
`ISynchronizeStateCommand`	`createSynchronizeStateCommand()` Synchronize the CMS states of elements from the working copy files state.
`IUpdateCommand`	`createUpdateCommand()`
`IRepositoryProperties`	`getAdminProperties(IGModelFragment fragment)` Get a repository administration properties.
`IProcessExtension`	`getDefaultHook()` Get the default hook called by Subversion at various time during a Subversion operation.
`IFileChangesRecorder`	`getFileChangeRecorder()` Get the service that records changes on external files to be versioned and associated to CMS nodes.
`IProcessExtension`	`getHook()`
`ICmsMetamodelExtensionPoints`	`getMetamodelExtensions()`
`IUserLabelProvider`	`getUserLabelProvider()` Get the label provider used to render the user name from a SVN user identifier.
`void`	`removeCodeReverser(ICodeReverser reverser)` Remove a code reverser.
`void`	`setHook(IProcessExtension hook)` Set the process extension hook and forgets the previous one.
`void`	`setUserLabelProvider(IUserLabelProvider labelProvider)` Set the label provider to render the user name from a SVN user identifier.

- Method Detail
  - addCodeReverser
```
void addCodeReverser(ICodeReverser reverser)
              throws java.lang.IllegalArgumentException
```
    Add a code reverser that will be called before committing elements.
    
    Parameters:
    
    reverser - The code reverser to add. Must not be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if reverser is null.
  - removeCodeReverser
```
void removeCodeReverser(ICodeReverser reverser)
                 throws java.lang.IllegalArgumentException
```
    Remove a code reverser.
    
    Parameters:
    
    reverser - The code reverser to remove. Must not be null.
    
    Throws:
    
    java.lang.IllegalArgumentException - if reverser is null.
  - createAddCommand
```
IAddCommand createAddCommand()
```
    Create a "Add to version" command.
    
    Returns:
    
    a new "add to version" command.
  - createBreakLockCommand
```
IBreakLockCommand createBreakLockCommand()
```
    Create a "Break lock" command.
    
    Returns:
    
    a new "Break lock" command.
  - createCancelAddCommand
```
ICancelAddCommand createCancelAddCommand()
```
    Create a "Cancel Add" command.
    Used to cancel the addition of elements scheduled for addition to version.
    
    Returns:
    
    a new cancel command.
  - createCleanUpCommand
```
ICleanupWorkingCopyCommand createCleanUpCommand()
```
    Create a command that Cleanup and repair the working copy.
    
    Returns:
    
    Cleanup and repair the working copy command.
  - createCommitCommand
```
ICommitCommand createCommitCommand()
```
    Create a command to commit the elements in subversion and put the CMS lock on them so that they cannot be modified again.
    The command must first be parameterized, then execute() can be called.
    
    Returns:
    
    a commit command.
  - createGetLockCommand
```
IGetLockCommand createGetLockCommand()
```
    Create a "Get lock" command.
    
    Returns:
    
    the get lock command.
  - createRemoveCommand
```
IRemoveCommand createRemoveCommand()
```
    Returns:
    
    the remove from version engine.
  - createRepairCommand
```
IRepairCommand createRepairCommand(IGModelFragment fragment)
```
    Create a repository repair command.
    For internal use only.
    
    Parameters:
    
    fragment - the CMS fragment to repair.
    
    Returns:
    
    a repository repair command.
  - createRevertCommand
```
IRevertCommand createRevertCommand()
```
    Create a "Revert" command.
    
    Returns:
    
    a revert command.
  - createSymbolService
```
ISymbolService createSymbolService()
```
    Create a symbol service.
    A symbol service is able to give the name and the complete name of an element even if it is not yet/anymore in the project but still in the repository.
    
    Returns:
    
    a symbol service.
  - createUpdateCommand
```
IUpdateCommand createUpdateCommand()
```
    Returns:
    
    the update engine.
  - getAdminProperties
```
IRepositoryProperties getAdminProperties(IGModelFragment fragment)
                                  throws java.io.IOException
```
    Get a repository administration properties.
    Administration properties are defined by the repository administrator.
    
    Parameters:
    
    fragment - a CMS fragment
    
    Returns:
    
    the repository properties.
    
    Throws:
    
    java.io.IOException - in case of failure
  - getDefaultHook
```
IProcessExtension getDefaultHook()
```
    Get the default hook called by Subversion at various time during a Subversion operation. Other hook can use it to delegate operations when they don't want to change the default behavior.
    
    Returns:
    
    the default built in hook
  - getHook
```
IProcessExtension getHook()
```
    Returns:
    
    the process extension.
  - setHook
```
void setHook(IProcessExtension hook)
```
    Set the process extension hook and forgets the previous one.
    The hook is called by the CMS engine at various time during a CMS operation.
    
    Parameters:
    
    hook - the new process extension hook.
  - setUserLabelProvider
```
void setUserLabelProvider(IUserLabelProvider labelProvider)
```
    Set the label provider to render the user name from a SVN user identifier.
    Since Modelio Server 4.0 SVN users login are an UUID that needs to be translated, using Modelio server REST services.
    
    Parameters:
    
    labelProvider - a label provider
    
    Since:
    
    5.2
  - createSynchronizeStateCommand
```
ISynchronizeStateCommand createSynchronizeStateCommand()
```
    Synchronize the CMS states of elements from the working copy files state.
    This command is usually useless.
    
    Returns:
    
    a synchronize state command.
  - createMergeCommand
```
IMergeCommand createMergeCommand()
```
    Creates a merge command.
    
    Returns:
    
    a merge command.
  - createConnectDirToRepositoryCommand
```
IConnectDirToRepositoryCommand createConnectDirToRepositoryCommand()
```
    Create a command to checkout a repository directory into a working copy.
    
    Returns:
    
    a repository connection command.
    
    Since:
    
    3.5
  - getFileChangeRecorder
```
IFileChangesRecorder getFileChangeRecorder()
```
    Get the service that records changes on external files to be versioned and associated to CMS nodes.
    All recorded changes are automatically added to the next SVN operation run on the associated CMS node (committed with the model, or reverted with it).
    
    Returns:
    
    the file changes recorder.
    
    Since:
    
    3.5
  - createCreateBranchCommand
```
ICreateBranchCommand createCreateBranchCommand()
```
    Create a command to create a branch.
    
    Returns:
    
    the branch creation command.
    
    Since:
    
    3.5
  - createCreateTagCommand
```
ICreateTagCommand createCreateTagCommand()
```
    Create a command to create a tag.
    
    Returns:
    
    the tag creation command.
    
    Since:
    
    3.5
  - getMetamodelExtensions
```
ICmsMetamodelExtensionPoints getMetamodelExtensions()
```
    Returns:
    
    the metamodel CMS extensions point.
    
    Since:
    
    3.6
  - getUserLabelProvider
```
IUserLabelProvider getUserLabelProvider()
```
    Get the label provider used to render the user name from a SVN user identifier.
    Since Modelio Server 4.0 SVN users login are an UUID that needs to be translated, using Modelio server REST services.
    
    Returns:
    
    a label provider used to display SVN user names.
    
    Since:
    
    5.2

Interface ICmsServices

Method Summary

Method Detail

addCodeReverser

removeCodeReverser

createAddCommand

createBreakLockCommand

createCancelAddCommand

createCleanUpCommand

createCommitCommand

createGetLockCommand

createRemoveCommand

createRepairCommand

createRevertCommand

createSymbolService

createUpdateCommand

getAdminProperties

getDefaultHook

getHook

setHook

setUserLabelProvider

createSynchronizeStateCommand

createMergeCommand

createConnectDirToRepositoryCommand

getFileChangeRecorder

createCreateBranchCommand

createCreateTagCommand

getMetamodelExtensions

getUserLabelProvider