Package com.comsol.api.database.param

Interface SearchItemsForBranchParamGenerator

    • Method Detail

      • withItemTypes

        default SearchItemsForBranchParamGenerator withItemTypes​(ItemType... itemTypes)
        Set the types for the searched items. Defaults to models and files if skipped. Invoking this method with zero arguments will result in searching all types of items.
        Parameters:
        itemTypes - The types for the searched items.
        Returns:
        A copy of this instance.

      • withItemTypes

        SearchItemsForBranchParamGenerator withItemTypes​(java.util.Collection<ItemType> itemTypes)
        Set the types for the searched items. Defaults to models and files if skipped. Pass an empty collection to match all types of items.
        Parameters:
        itemTypes - The types for the searched items.
        Returns:
        A copy of this instance.

      • withSearchText

        SearchItemsForBranchParamGenerator withSearchText​(java.lang.String searchText)

        Set the search text to match latest item versions with.

        The search text can contain plain search words and any number of filter expressions using the Model Manager search syntax. Plain search words must be written first followed by filter expressions. Optionally use boolean operators AND and OR to combine different filter expressions. When skipping such boolean operators, spaces are automatically interpreted as AND. Example syntax for filter expressions may be seen in the Filter dialog box under Filter query preview in the Model Manager window in the COMSOL Desktop.

        Filter expressions may also be set via withSearchFilters(java.lang.String...). Such filter expressions are combined using AND-logic with any filter expressions specified here.

        Parameters:
        searchText - The search text to match latest item versions with. Passing an empty string results in a search text that matches any version.
        Returns:
        A copy of this instance.

      • withSearchFilters

        default SearchItemsForBranchParamGenerator withSearchFilters​(java.lang.String... searchFilters)

        Set search filters to match latest item versions with.

        The search filters are expressed using the Model Manager search syntax. Example syntax for filter expressions may be seen in the Filter dialog box under Filter query preview in the Model Manager window in the COMSOL Desktop. Multiple filters provided to this method will be combined with AND-logic. These are then combined with any filters included with the expression set via withSearchText(String) using AND-logic.

        Parameters:
        searchFilters - Search filters written using the Model Manager search syntax.
        Returns:
        A copy of this instance.

      • withSearchFilters

        SearchItemsForBranchParamGenerator withSearchFilters​(java.util.Collection<java.lang.String> searchFilters)

        Set search filters to match latest item versions with.

        The search filters are expressed using the Model Manager search syntax. Example syntax for filter expressions may be seen in the Filter dialog box under Filter query preview in the Model Manager window in the COMSOL Desktop. Multiple filters provided to this method will be combined with AND-logic. These are then combined with any filters included with the expression set via withSearchText(String) using AND-logic.

        Parameters:
        searchFilters - Search filters written using the Model Manager search syntax.
        Returns:
        A copy of this instance.

      • withSortByRank

        default SearchItemsForBranchParamGenerator withSortByRank()
        Sort the search result by the relevance rank of matching item versions. The sort order is always descending (highest relevance rank first).
        Returns:
        A copy of this instance.

      • withSortByTitle

        default SearchItemsForBranchParamGenerator withSortByTitle()
        Sort the search result by the title of matching item versions.
        Returns:
        A copy of this instance.

      • withSortBySaved

        default SearchItemsForBranchParamGenerator withSortBySaved()
        Sort the search result by the saved date of matching item versions.
        Returns:
        A copy of this instance.

      • withSortBySavedIn

        default SearchItemsForBranchParamGenerator withSortBySavedIn()

        Sort the search result by the COMSOL Multiphysics version that the model object contents of matching model versions were saved in.

        Item versions other than model versions are always returned last in the search result when sorting on the saved in-field.

        Returns:
        A copy of this instance.
        Since:
        6.4

      • withSortBySize

        default SearchItemsForBranchParamGenerator withSortBySize()
        Sort the search result by the estimated disk space usage of matching item versions.
        Returns:
        A copy of this instance.

      • withSortByComputedData

        default SearchItemsForBranchParamGenerator withSortByComputedData()
        Sort the search result by the size of built, computed, and plotted data belonging to matching item versions.
        Returns:
        A copy of this instance.

      • withSortField

        SearchItemsForBranchParamGenerator withSortField​(ItemSortField sortField)
        Set the field with which the matching item versions should be sorted by.
        Parameters:
        sortField - The field to sort by.
        Returns:
        A copy of this instance.

      • withSortAscending

        default SearchItemsForBranchParamGenerator withSortAscending()
        Sort the search result by ascending (increasing) order.
        Returns:
        A copy of this instance.

      • withSortDescending

        default SearchItemsForBranchParamGenerator withSortDescending()
        Sort the search result by descending (decreasing) order.
        Returns:
        A copy of this instance.

      • withSortOrder

        SearchItemsForBranchParamGenerator withSortOrder​(SortOrder sortOrder)
        Set the sort order of the search result. Any value set here is ignored if sorting on relevance ranking.
        Parameters:
        sortOrder - A sort order value.
        Returns:
        A copy of this instance.