Package com.collabnet.ce.soap60.webservices.scm

Class ScmCheckoutCommandsBuilder

  • public class ScmCheckoutCommandsBuilder
extends Object
    Builds checkout commands for master repository.
    Since:
    8.1

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected com.vasoftware.sf.server.services.scm.RepositoryDO repository  
      protected com.vasoftware.sf.server.types.UserSessionKey sessionKey  
      protected com.vasoftware.sf.server.services.user.UserDO user  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.vasoftware.sf.server.services.scm.CheckoutCommand.CheckoutCommandSpecification build()
      Builds repository checkout commands out of provided parameters.
      protected U getCheckoutData()
      Gets AbstractScmCommandsCheckoutBuilder.BasicCheckoutData
      T withRepository​(com.vasoftware.sf.server.services.scm.RepositoryDO repositoryData)  
      T withSession​(com.vasoftware.sf.server.types.UserSessionKey inputSessionKey)  
      T withUser​(com.vasoftware.sf.server.services.user.UserDO inputUser)  

    • Field Detail

      • sessionKey

        protected com.vasoftware.sf.server.types.UserSessionKey sessionKey

      • user

        protected com.vasoftware.sf.server.services.user.UserDO user

      • repository

        protected com.vasoftware.sf.server.services.scm.RepositoryDO repository

    • Constructor Detail

      • ScmCheckoutCommandsBuilder

        public ScmCheckoutCommandsBuilder()

    • Method Detail

      • build

        public com.vasoftware.sf.server.services.scm.CheckoutCommand.CheckoutCommandSpecification build()
                                                                                         throws NoSuchObjectFault,
                                                                                                SystemFault
        Builds repository checkout commands out of provided parameters.
        Returns:
        never null
        Throws:
        NoSuchObjectFault - see getCheckoutData() for details
        SystemFault - see getCheckoutData() for details

      • withSession

        public T withSession​(com.vasoftware.sf.server.types.UserSessionKey inputSessionKey)
        Parameters:
        inputSessionKey - is added to available parameters
        Returns:
        this instance

      • withUser

        public T withUser​(com.vasoftware.sf.server.services.user.UserDO inputUser)
        Parameters:
        inputUser - is added to available parameters
        Returns:
        this instance

      • withRepository

        public T withRepository​(com.vasoftware.sf.server.services.scm.RepositoryDO repositoryData)
        Parameters:
        repositoryData - is added to available parameters
        Returns:
        this instance

      • getCheckoutData

        protected U getCheckoutData()
                     throws NoSuchObjectFault,
                            SystemFault
        Gets AbstractScmCommandsCheckoutBuilder.BasicCheckoutData
        Returns:
        never null
        Throws:
        NoSuchObjectFault - when neither system nor strategy couldn't have been obtained
        SystemFault - when non-SCM system id was provided