IScmManager interface
Namespace: NextDesign.Desktop
Description
An access object to configuration management.
Affiliation area
| Name | Description |
|---|---|
| Team Development | A group of APIs that provide operations for working with configuration management systems for team development. |
Method
| Name | Description |
|---|---|
| CheckoutProject | Checks out the project at the specified project path (remote repository path) to the specified workspace. |
| CommitProject | Commits changes in the specified project to the configuration management repository. If there are no changes in the specified project, nothing is done. Also, if the specified project is not linked to the configuration management system, nothing will be done. |
| CommitUnits | Commits the changes in the specified unit of the specified project to the configuration management repository. If there are no changes in the specified unit, nothing is done. Also, if the specified project is not linked to the configuration management system, nothing will be done. |
| CreateScmRepositorySetting | Creates a new configuration management connection setting with the specified connection information. |
| GetAllEditPermissions | Gets edit permissions for all units in the specified project. If the profile is unitized, the unit of the profile is also included. If the specified project is not linked to the configuration management system, nothing will be done. Among the target units, the units that could acquire the authority and the units that could not acquire the authority can be identified by checking the authority acquisition result object of the return value. |
| GetChangedUnits | Gets changed units in the specified project. Returns an empty collection if the specified project is not linked to a configuration management system. The unit change will be confirmed when you save the project. If the project has not been saved, identify the units that have changed since the last save. Changes to the unit can be examined by checking the IModelUnit.ScmStatus.ScmState property. |
| GetEditPermission | Gets edit permission for the specified unit in the specified project. If the specified project is not linked to the configuration management system, nothing will be done. If the specified unit already has edit authority, it is treated as successful without obtaining authority. Whether or not the unit was able to acquire authority can be identified by checking the authority acquisition result object of the return value. |
| GetEditPermissions | Gets edit permissions for all the specified units in the specified project. If the specified project is not linked to the configuration management system, nothing will be done. Among the specified units, units that already have edit privileges are treated as successful without acquiring privileges. Of the target units, the units that were able to acquire the authority and the units that could not acquire the authority can be identified by checking the authority acquisition result object of the return value. |
| GetRemotePath | Gets the remote path (repository path) for the specified unit in the specified project. |
| GetRepositorySetting(IProject) | Gets the configuration management connection settings corresponding to the specified project. |
| GetRepositorySetting(string) | Gets the configuration management connection setting with the given name. |
| GetRepositorySettings | Gets all defined configuration management connection settings. |
| IsScmFolder | Checks if the specified path is a configuration management system working folder. Returns true if the working folder of the configuration management system. |
| IsScmItem | Checks if the specified project is already integrated with a configuration management system. Returns true if linked. |
| ReleaseAllEditPermissions | Releases edit permissions for all units in the specified project. If the profile is unitized, the unit of the profile is also included. If the specified project is not linked to the configuration management system, nothing will be done. Of the target units, the unit whose authority could be released and the unit whose authority could not be released can be identified by checking the authority acquisition result object of the return value. |
| ReleaseEditPermission | Releases edit permission for the specified unit in the specified project. If the specified project is not linked to the configuration management system, nothing will be done. If the specified unit does not have edit authority, it is treated as successful without releasing the authority. Whether or not the authority of the unit has been released can be identified by checking the authority acquisition result object of the return value. |
| ReleaseEditPermissions | Releases edit permissions for the specified unit in the specified project. If the specified project is not linked to the configuration management system, nothing will be done. The unit that does not hold the editing authority among the specified units will be treated as successful without releasing the authority. Of the target units, the unit whose authority could be released and the unit whose authority could not be released can be identified by checking the authority acquisition result object of the return value. |
| RevertProject | Reverts all unit changes in the specified project. If there are no changes in the specified project, nothing is done. Also, if the specified project is not linked to the configuration management system, nothing will be done. |
| RevertUnits | Revert changes for the specified unit in the specified project. If there are no changes in the specified unit, nothing is done. Also, if the specified project is not linked to the configuration management system, nothing will be done. |
| ShareProject | Shares the specified project with the specified configuration management repository. |
| UpdateProject | Updates the specified project to the latest state in the configuration management repository. If the specified project is not linked to the configuration management system, nothing will be done. |