IScmManager Interface
Namespace: NextDesign.Desktop
Description
Access object for configuration management.
Belonging Area
| Name | Description |
|---|---|
| Team Collaboration | A group of APIs that provide collaboration operations with configuration management systems for team development. |
Method
| Name | Description |
|---|---|
| CheckoutProject | Checks out the project with the specified project path (remote repository path) to the specified working area. |
| CommitProject | Commits the changes of the specified project and commits them to the configuration management repository. Nothing is done if there are no changes to the specified project. Nothing is done if the specified project is not linked to the configuration management system. |
| CommitUnits | Confirms the changes to the specified units in the specified project and commits them to the configuration management repository. Nothing is done if there are no changes to the specified units. Nothing is done if the specified project is not linked to the configuration management system. |
| CreateScmRepositorySetting | Generates 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 units in the profile are also included. Nothing is done if the specified project is not linked to the configuration management system. The units for which permissions were obtained and the units for which permissions were not obtained can be identified by checking the permission acquisition result object of the returned value. |
| GetChangedUnits | Gets the units that have changed in the specified project. If the specified project is not linked to the configuration management system, an empty collection is returned. The unit changes are finalized when the project is saved. If the project has not been saved, the units that have changed since the last time they were saved are identified. The changes made to the units can be found 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 is done. If the specified unit already has edit permission, the permission acquisition is not performed and the operation is treated as successful. You can identify whether the unit has acquired permission by checking the permission acquisition result object in the returned value. |
| GetEditPermissions | Gets edit permissions for all the specified units in the specified project. Nothing will be done if the specified project is not linked to the configuration management system. For the specified units that already have edit permissions, permission acquisition will not be performed and the operation will be treated as successful. The units that were granted permission and those that were not granted permission can be identified by checking the permission acquisition result object returned. |
| GetRemotePath | Gets the remote path (repository path) of the specified unit in the specified project. |
| GetRepositorySetting(IProject) | Gets the configuration management connection setting corresponding to the specified project. |
| GetRepositorySetting(string) | Gets the configuration management connection setting with the specified name. |
| GetRepositorySettings | Gets all defined configuration management connection settings. |
| IsScmFolder | Checks whether the specified path is the working folder of the configuration management system. Returns true if it is the working folder of the configuration management system. |
| IsScmItem | Checks whether the specified project is already linked to the configuration management system. Returns true if it is already linked. |
| ReleaseAllEditPermissions | Releases edit permissions for all units in the specified project. If the profile is unitized, the profile's units will also be targeted. Nothing will be done if the specified project is not yet linked to the configuration management system. The units for which permissions were released and the units for which permissions were not released can be identified by checking the returned permission acquisition result object. |
| ReleaseEditPermission | Releases the 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 permission, the permission will not be released and the operation will be treated as successful. You can check whether the unit's permission was released by checking the permission acquisition result object of the returned value. |
| ReleaseEditPermissions | Releases the 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 permission, the permission will not be released and the operation will be treated as successful. You can check the permission acquisition result object of the returned value to identify which units were released and which were not released. |
| RevertProject | Discards changes in all units of the specified project. Nothing is done if there are no changes in the specified project. Nothing is done if the specified project is not integrated with the configuration management system. |
| RevertUnits | Discards changes in the specified units of the specified project. Nothing is done if there are no changes in the specified units. Nothing is done if the specified project is not integrated with the configuration management system. |
| ShareProject | Shares the specified project in the specified configuration management repository. |
| UpdateProject | Updates the specified project to the latest state in the configuration management repository. Nothing is done if the specified project is not integrated with the configuration management system. |