Package com.microstrategy.webapi.paramsobject

Class SynchronousQuickSearch.Builder

  • Enclosing class:
    SynchronousQuickSearch
    public static class SynchronousQuickSearch.Builder
extends java.lang.Object

    • Method Detail

      • sessionID

        public SynchronousQuickSearch.Builder sessionID​(java.lang.String sessionID)
        Set a valid Session ID.
        Parameters:
        sessionID -
        Returns:

      • quickSearchCmd

        public SynchronousQuickSearch.Builder quickSearchCmd​(int quickSearchCmd)
        Set what type of data need to get back from the quick search command. quickSearchCmd=1 means get quick search status, quickSearchCmd=2 means do quick search.
        Parameters:
        quickSearchCmd -
        Returns:

      • namePattern

        public SynchronousQuickSearch.Builder namePattern​(java.lang.String namePattern)
        Query in object name, If namePattern is empty, it means search all objects.
        Parameters:
        namePattern -
        Returns:

      • startObject

        public SynchronousQuickSearch.Builder startObject​(int startObject)
        Set startObject
        Parameters:
        startObject - 0 based, the start index of returned objects.
        Returns:

      • count

        public SynchronousQuickSearch.Builder count​(int count)
        Set the max number of objects to be returned, usually equals to the page size.
        Parameters:
        count -
        Returns:

      • searchType

        public SynchronousQuickSearch.Builder searchType​(int searchType)
        Set the type of quick search, 0=contains, 2=exactly, 3=beginwith, 5=endwith; -1=not use quick search

        Optional parameter

        Parameters:
        searchType -
        Returns:

      • descriptionPattern

        public SynchronousQuickSearch.Builder descriptionPattern​(java.lang.String descriptionPattern)
        Query in object description.
        Parameters:
        descriptionPattern -
        Returns:

      • recursive

        public SynchronousQuickSearch.Builder recursive​(boolean recursive)
        Set whether search in sub folders recursively, 0 means false, others means true.
        Parameters:
        recursive -
        Returns:

      • includeManagedObject

        public SynchronousQuickSearch.Builder includeManagedObject​(boolean includeManagedObject)
        Set whether include managed objects
        Parameters:
        includeManagedObject -
        Returns:

      • resolveShortcut

        public SynchronousQuickSearch.Builder resolveShortcut​(boolean resolveShortcut)
        Set resolve shortcut to target
        Parameters:
        resolveShortcut -
        Returns:

      • searchFolders

        public SynchronousQuickSearch.Builder searchFolders​(java.lang.String searchFolders)
        Set search Folders
        Parameters:
        searchFolders - Define folder ID(s) we need to search in which folder/folders. If there are multiple folders, the ids should be separated by space.
        Returns:

      • ownerIds

        public SynchronousQuickSearch.Builder ownerIds​(java.lang.String ownerIds)
        Define owner ID(s) we need to search in objects owned by. If there are multiple owners, the ids should be separated by space.
        Parameters:
        ownerIds -
        Returns:

      • types

        public SynchronousQuickSearch.Builder types​(java.lang.String types)
        Define the object type(s) we need to search. If there are multiple types, the types should be separated by space. It could be either type or subtype.
        Parameters:
        types -
        Returns:

      • beginCreateTime

        public SynchronousQuickSearch.Builder beginCreateTime​(java.lang.String beginCreateTime)
        Begin Create Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
        Parameters:
        beginCreateTime -
        Returns:

      • endCreateTime

        public SynchronousQuickSearch.Builder endCreateTime​(java.lang.String endCreateTime)
        End Create Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
        Parameters:
        endCreateTime -
        Returns:

      • beginModifyTime

        public SynchronousQuickSearch.Builder beginModifyTime​(java.lang.String beginModifyTime)
        Begin Modify Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
        Parameters:
        beginModifyTime -
        Returns:

      • endModifyTime

        public SynchronousQuickSearch.Builder endModifyTime​(java.lang.String endModifyTime)
        End Modify Time GMT. The time is in ISO 8601 format (YYYY-MM-DD hh:mm:ss.msec).
        Parameters:
        endModifyTime -
        Returns:

      • outputType

        public SynchronousQuickSearch.Builder outputType​(int outputType)
        Define the output type of the search result. "1" means json type, "2" means XML type.
        Parameters:
        outputType -
        Returns:

      • quickSearchVisibility

        public SynchronousQuickSearch.Builder quickSearchVisibility​(EnumDSSXMLQuickSearchVisibility quickSearchVisibility)
        Set quick search visibility, 0 -> return visible object only; 1 -> return hidden object only; 2 -> return both hidden and visible object
        Parameters:
        quickSearchVisibility -
        Returns:

      • quickSearchCertifiedStatus

        public SynchronousQuickSearch.Builder quickSearchCertifiedStatus​(EnumDSSXMLQuickSearchCertifiedStatus quickSearchCertifiedStatus)
        Set quickSearchCertifiedStatus 0 -> return none certified only; 1 -> return certfied only; 2 -> return both certified and none certified object
        Parameters:
        quickSearchCertifiedStatus -
        Returns:

      • sourceObjectId

        public SynchronousQuickSearch.Builder sourceObjectId​(java.lang.String sourceObjectId)
        Set sourceObjectId, the source object id for the recommendation
        Parameters:
        sourceObjectId -
        Returns:

      • sourceObjectType

        public SynchronousQuickSearch.Builder sourceObjectType​(int sourceObjectType)
        Set sourceObjectType, the source object type for the recommendation
        Parameters:
        sourceObjectType -
        Returns:

      • sourceObjectProjectId

        public SynchronousQuickSearch.Builder sourceObjectProjectId​(java.lang.String sourceObjectProjectId)
        Set sourceObjectProjectId, the source object project id for the recommendation
        Parameters:
        sourceObjectProjectId -
        Returns:

      • recommendationQueryString

        public SynchronousQuickSearch.Builder recommendationQueryString​(java.lang.String recommendationQueryString)
        Set sourceObjectProjectId, the source object project id for the recommendation
        Parameters:
        recommendationQueryString -
        Returns:

      • quickSearchFields

        public SynchronousQuickSearch.Builder quickSearchFields​(java.lang.Integer quickSearchFields)
        Set quickSearchFields, the fields of the quick search
        Parameters:
        quickSearchFields -
        Returns: