Package com.nomagic.magicdraw.teamwork2

Interface ITeamworkService

All Known Implementing Classes:
TeamworkService
@OpenApiAll public interface ITeamworkService
Interface for team server service

  • Field Details

  • Method Details

    • getServiceID

      @Nonnull String getServiceID()
      Return service id.
      Returns:
      service id

    • isConnected

      boolean isConnected()
      Returns true, when connection between MD and server is established.
      Returns:
      true, when user is connected to server.

    • isLiveConnection

      boolean isLiveConnection()
      Check if there is a live server connection
      Returns:
      true if connection is live.

    • getConnectedUser

      @CheckForNull String getConnectedUser()
      Returns name of connected user .
      Returns:
      User name of connected user. Null when no user is connected.

    • login

      boolean login(boolean useLastLoginData)
      Logs into last successful server using last successful input data.
      Parameters:
      useLastLoginData - true use last login data, false - specify new login data.
      Returns:
      return true if log-in was successful.
      See Also:

    • login

      void login(@Nonnull ServerLoginInfo info, boolean encryptPassword)
      Login with given data
      Parameters:
      info - login info
      encryptPassword - encrypt password from given info

    • logout

      boolean logout()
      Logs out from server.
      Returns:
      True, when log out was successful.

    • setLastUsedTeamworkInfo

      void setLastUsedTeamworkInfo(@Nonnull ServerLoginInfo info, boolean encryptPassword)
      Saves given input data, as last successful user connection info.
      Parameters:
      info - login info
      encryptPassword - encrypt password from given info

    • getLastUsedLoginInfo

      ServerLoginInfo getLastUsedLoginInfo()
      Returns list of input data, which was entered on last successful connection. Array of: login username, pass, servername.
      Returns:
      array of username, pass, servername.

    • setAsLastUsedService

      void setAsLastUsedService()
      Set that current service is last used service to connect to server from MD.

    • getProjectDescriptors

      List<ProjectDescriptor> getProjectDescriptors() throws Exception
      Collect information about all projects on server
      Returns:
      descriptors of all projects
      Throws:
      Exception - in case of some error

    • getProjectDescriptorById

      ProjectDescriptor getProjectDescriptorById(String id) throws Exception
      Returns descriptor of project with given id
      Parameters:
      id - project id
      Returns:
      descriptor
      Throws:
      Exception - in case of some error

    • getProjectIdByQualifiedName

      String getProjectIdByQualifiedName(String qualifiedName) throws Exception
      Returns project id for given project qualified name.
      Parameters:
      qualifiedName - project qualified name, unique name constructed from project name and it's branches. Examples: "MyProject" with no branches = "MyProject" "MyProject" branch ["release"] = "MyProject##release" "MyProject" branch with subbranch ["release", "sp1"] = "MyProject##release##sp1"
      Returns:
      project id.
      Throws:
      Exception - in case of some error

    • getProjectDescriptorByQualifiedName

      ProjectDescriptor getProjectDescriptorByQualifiedName(String qualifiedName) throws Exception
      Returns project descriptor.
      Parameters:
      qualifiedName - project qualified name, unique name constructed from project name and it's branches.

      E.g:

      "MyProject" with no branches = "MyProject"
      "MyProject" branch ["release"] = "MyProject##release"
      "MyProject" branch with subbranch ["release", "sp1"] = "MyProject##release##sp1"
      Returns:
      remote project descriptor
      Throws:
      Exception - in case of some error

    • getVersions

      List<com.nomagic.ci.persistence.versioning.IVersionDescriptor> getVersions(ProjectDescriptor descriptor) throws Exception
      Versions of given project
      Parameters:
      descriptor - descriptor.
      Returns:
      versions
      Throws:
      Exception - in case of some error

    • getVersion

      com.nomagic.ci.persistence.versioning.IVersionDescriptor getVersion(@Nonnull Project project)
      Current versions of given project
      Parameters:
      project - project
      Returns:
      versions