Package jetbrains.buildServer.controllers.agent

Class PoolProjectSelectorDescriptor

    • Method Detail

      • createContext

        @NotNull
public jetbrains.buildServer.controllers.agent.PoolProjectSelectorData createContext​(@Nullable
                                                                                     String contextId,
                                                                                     @NotNull
                                                                                     javax.servlet.http.HttpServletRequest request)
        Description copied from class: CheckListPopupDialogType
        Creates context object. Context is an object that holds any info about the certain popup showing. Method is called only one time per popup showing.
        Specified by:
        createContext in class CheckListPopupDialogType<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Returns:
        see above

      • collectItems

        @NotNull
public List<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem> collectItems​(@NotNull
                                                                                          jetbrains.buildServer.controllers.agent.PoolProjectSelectorData context)
        Description copied from class: CheckListPopupDialogType
        Collects the items to be listed in popup. Actually Item_T need not implement any interfaces, the information about the item is got via CheckListPopupDialogType.createItemInfo(Object, Object) method. Method is called only one time per popup showing.
        Specified by:
        collectItems in class CheckListPopupDialogType<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Parameters:
        context - check list popup context, see CheckListPopupDialogType for more info
        Returns:
        list of the items to be listed in popup in the order in which they must be listed

      • createItemInfo

        @NotNull
public CheckListItemInfo createItemInfo​(@NotNull
                                        jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem item,
                                        @NotNull
                                        jetbrains.buildServer.controllers.agent.PoolProjectSelectorData context)
        Description copied from class: CheckListPopupDialogType
        Provides the information about the specified item. This method and all the methods of the created info object are called only one time per item per popup showing.
        Specified by:
        createItemInfo in class CheckListPopupDialogType<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Parameters:
        item - item to get information about
        context - check list popup context, see CheckListPopupDialogType for more info
        Returns:
        information of the specified item

      • getTopHtmlNote

        @Nullable
public String getTopHtmlNote()
        Description copied from class: CheckListPopupDialogType
        Returns HTML message to be shown on the top of the popup (message is not escaped, so can contain HTML code).
        Specified by:
        getTopHtmlNote in class CheckListPopupDialogType<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Returns:
        see above

      • getCustomOptions

        @NotNull
public Boolean getCustomOptions​(@NotNull
                                javax.servlet.http.HttpServletRequest request,
                                @NotNull
                                jetbrains.buildServer.controllers.agent.PoolProjectSelectorData context)
        Description copied from interface: CheckListCustomOptionsSupport
        Creates bean with custom options to be passed into custom options JSP page. This method can be called in two cases:
        • Initializing GET request - then there are no custom parameters in request, so you must create default bean
        • Some POST requests - then request contains the values of all form elements on your JSP page
        Specified by:
        getCustomOptions in interface CheckListCustomOptionsSupport<jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Returns:
        see above

      • createFilteringSupport

        @NotNull
public CheckListFilteringSupport<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData> createFilteringSupport​(@NotNull
                                                                                                                                                                                               jetbrains.buildServer.controllers.agent.PoolProjectSelectorData context)
        Description copied from class: CheckListPopupDialogType
        Creates implementation of filtering support. See CheckListFilteringSupport for more info. Method is called only one time per popup showing.
        Specified by:
        createFilteringSupport in class CheckListPopupDialogType<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Parameters:
        context - check list popup context, see CheckListPopupDialogType for more info
        Returns:
        implementation of filtering support or null

      • filterItems

        @NotNull
public Set<String> filterItems​(@NotNull
                               List<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem> items,
                               @NotNull
                               String keyPhrase,
                               @NotNull
                               jetbrains.buildServer.controllers.agent.PoolProjectSelectorData context)
        Description copied from interface: CheckListFilteringSupport
        Filters check list items.
        Specified by:
        filterItems in interface CheckListFilteringSupport<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData>
        Parameters:
        items - all check list items (items and their order are same as in the list which was returned from CheckListPopupDialogType.collectItems(Object))
        keyPhrase - key phrase to filter items by; is guaranteed to be trimmed and non-empty
        context - check list popup context, see CheckListPopupDialogType for more info
        Returns:
        set of the accepted item identifiers (item identifiers must correspond to the ones, which were returned from CheckListItemInfo.getId())

      • createValidationSupport

        @NotNull
public CheckListValidationSupport<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean> createValidationSupport​(@NotNull
                                                                                                                                                                                                               jetbrains.buildServer.controllers.agent.PoolProjectSelectorData context)
        Description copied from class: CheckListPopupDialogType
        Creates implementation of validation support. See CheckListValidationSupport for more info. Method is called only one time per popup showing.
        Specified by:
        createValidationSupport in class CheckListPopupDialogType<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Parameters:
        context - check list popup context, see CheckListPopupDialogType for more info
        Returns:
        implementation of validation support or null

      • getWarnings

        @NotNull
public List<Warning> getWarnings​(@NotNull
                                 List<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem> checkedItems,
                                 @Nullable
                                 Boolean dissociateFromOtherPools,
                                 @NotNull
                                 jetbrains.buildServer.controllers.agent.PoolProjectSelectorData context)
        Description copied from interface: CheckListValidationSupport
        Collects warnings to be shown to user. Method is called on every user change.
        Specified by:
        getWarnings in interface CheckListValidationSupport<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Parameters:
        checkedItems - checked list items (sublist of the list, returned by CheckListPopupDialogType.collectItems(Object) method, in the same order)
        dissociateFromOtherPools - not null custom options bean, which was provided by CheckListCustomOptionsSupport, or null if there is no custom options support
        context - check list popup context, see CheckListPopupDialogType for more info
        Returns:
        list of warnings to be listed in popup in the order in which they must be listed

      • getValidationProgressText

        @NotNull
public String getValidationProgressText()
        Description copied from interface: CheckListValidationSupport
        Returns the text to be displayed while warnings are being collected.
        Specified by:
        getValidationProgressText in interface CheckListValidationSupport<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Returns:
        see above

      • apply

        public void apply​(@NotNull
                  List<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem> checkedItems,
                  @Nullable
                  Boolean dissociateFromOtherPools,
                  @NotNull
                  jetbrains.buildServer.controllers.agent.PoolProjectSelectorData context)
        Description copied from class: CheckListPopupDialogType
        Applies user changes. Method is called after pressing "Apply" button or right after the changes were made, see #mustApplyChangesImmediately(Object) for more info.
        Specified by:
        apply in class CheckListPopupDialogType<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Parameters:
        checkedItems - checked list items (sublist of the list, returned by CheckListPopupDialogType.collectItems(Object) method, in the same order)
        dissociateFromOtherPools - not null custom options bean, which was provided by CheckListCustomOptionsSupport, or null if there is no custom options support
        context - check list popup context, see CheckListPopupDialogType for more info

      • disposeContext

        public void disposeContext​(@NotNull
                           jetbrains.buildServer.controllers.agent.PoolProjectSelectorData context)
        Description copied from class: CheckListPopupDialogType
        Disposes context object if needed. Method is called after pressing "Apply" button or "Cancel" link in popup and after showing popup of this type in new context.
        Specified by:
        disposeContext in class CheckListPopupDialogType<jetbrains.buildServer.controllers.agent.PoolProjectSelectorItem,​jetbrains.buildServer.controllers.agent.PoolProjectSelectorData,​Boolean>
        Parameters:
        context - check list popup context, see CheckListPopupDialogType for more info