Package com.iknowbase.api.presentationservices.quickLink

Interface QuickLinkBuilder

  • public interface QuickLinkBuilder
    A builder used to configure and build quickLink actions

    • Method Detail

      • buildElements

        List<ContentQueryAction> buildElements​(PresentationServicesClient client)
        Returns a List of ContentQueryAction built from parameters set on this builder. Each element in the list corresponds to a form or wizard defined in the quickLink.
        Returns:
        a List of ContentQueryAction built from parameters set on this builder

      • onCloseCallback

        QuickLinkBuilder onCloseCallback​(String functionName)
        Specify that the form opened by the edit action shall call a specified javascript function when closing.
        Parameters:
        functionName - name of javascript function to call
        Returns:
        this EditActionBuilder

      • onCloseUrl

        QuickLinkBuilder onCloseUrl​(String URL)
        Specify that the form opened by the edit action shall redirect to a specific URL when closing.
        Parameters:
        URL - URL to redirect to
        Returns:
        this EditActionBuilder

      • parameter

        QuickLinkBuilder parameter​(String name,
                           String value)
        Specify a parameter that is to be passed to the target.
        Parameters:
        name - parameter name
        value - parameter value
        Returns:
        this Builder

      • direct

        QuickLinkBuilder direct()
        Specify that the action should resolve directly to the target URL, without any redirection.

        Generating a direct action is slower than generating an indirect action, but the URL will reflect the actual target setup. Use direct actions only when the performance cost can be defended.

        Returns:
        this Builder

      • configure

        QuickLinkBuilder configure​(Consumer<QuickLinkBuilder> configurator)
        Calls a configuration function with this builder, to allow reusable configuration logic.

        This function calls a separate configurator function with this builder as a parameter. The configurator can then configure this builder as it sees fit. The main use case of this is to include a shared configuration as part of a fluent builder-pattern.

        Parameters:
        configurator - the configurator function
        Returns:
        this QuickLinkBuilder