Package com.nomagic.magicdraw.changespanel

Interface ChangeSetService

  • @OpenApiAll
public interface ChangeSetService
    Service to get information about Change Sets tab content.

    • Method Detail

      • getChangeSetNames

        java.util.Collection<java.lang.String> getChangeSetNames()
        Gets all change sets names displayed in Change Set tab.
        Returns:
        collection of change sets names

      • getChangeSetContent

        java.util.Collection<ChangeSetRepresentation> getChangeSetContent​(java.lang.String changeSetName)
                                                           throws java.lang.IllegalArgumentException
        Returns collection of specific change set content. Each item in collection represents hierarchical change set tab row.
        Parameters:
        changeSetName - change set name
        Returns:
        change set hierarchical content
        Throws:
        java.lang.IllegalArgumentException - in case of incorrect or not existing change set name was passed.

      • getChangeSetState

        ChangeSetService.ChangeSetState getChangeSetState​(java.lang.String changeSetName)
                                           throws java.lang.IllegalArgumentException
        Returns the state of specific change set which could be "Active" or "Suspended".
        Parameters:
        changeSetName - change set name
        Returns:
        change set state
        Throws:
        java.lang.IllegalArgumentException - in case of incorrect or not existing change set name was passed.

      • getActiveChangeSet

        java.lang.String getActiveChangeSet()
        Gets active change set and returns its name.
        Returns:
        change set name

      • isSetTagOnCommit

        boolean isSetTagOnCommit​(java.lang.String changeSetName)
                  throws java.lang.IllegalArgumentException
        Checks if 'Tag version with Change ID after commit' is selected. If true - change set name will be set as 'Version Tag' after commit.
        Parameters:
        changeSetName - change set name
        Returns:
        true if 'Tag version with Change ID after commit' is selected, otherwise false
        Throws:
        java.lang.IllegalArgumentException - in case of incorrect or not existing change set name was passed.