Package com.microstrategy.web.app.beans

Interface SearchBean

    • Method Detail

      • showResults

        boolean showResults()
        Returns:
        true if the folderBean is ready to display the search results

      • isFieldValid

        boolean isFieldValid​(java.lang.String field)
        Checks if the field has valid information. In the handleRequest method all the fields are validated and saved. This method checks if the field is in the list of invalid ones.
        Parameters:
        field - the name of the field
        Returns:
        true if the field contains valid information

      • setAdvanced

        void setAdvanced​(boolean advanced)
        Sets the bean to show in advaced/simple mode. In advanced mode all the search sections are displayed.
        Parameters:
        advanced - true if the bean should be render in advanced mode

      • isAdvanced

        boolean isAdvanced()
        Returns:
        whether the bean will be shown in advanced mode.

      • getFolderID

        java.lang.String getFolderID()
        Gets the folder ID where the user is coming from.
        Returns:
        the folder ID where the user is coming from.

      • setFolderID

        void setFolderID​(java.lang.String id)
        Sets the folderId. This however has no impact on the handleRequest method, is just to identify from which folder the user is coming from.
        Parameters:
        id - folder ID.

      • getFolderType

        int getFolderType()
        Gets the folder type, which specifies a system folder ID.
        Returns:
        the folder type.

      • setFolderType

        void setFolderType​(int type)
        Sets the folderType. This however has no impact on the handleRequest method, is just to identify from which folder the user is coming from.
        Parameters:
        type - the folder type.

      • getFolderName

        java.lang.String getFolderName()
        Gets the folder name where the user is coming from.
        Returns:
        the folder name.

      • setMaxWait

        void setMaxWait​(int wait)
        Sets the maximum time that a search will wait before returning. For more information refer to the WebSearch object.
        Parameters:
        wait - the waittime

      • getMaxWait

        int getMaxWait()
        Returns:
        the maximum time that a search will wait before returning. For more information refer to the WebSearch object.

      • getMaxObjects

        int getMaxObjects()
        Returns the maximum number of objects the search is configured to return. By default, this value is -1, meaning return all objects, but it can be changed by calling setMaxObjects.
        Returns:
        The maximum number of objects a search will return.
        See Also:
        setMaxObjects(int)

      • setMaxObjects

        void setMaxObjects​(int maxObjects)
        Sets the maximum number of objects that the search will return. Default is -1, meaning return all objects.
        Parameters:
        maxObjects - The maximum number of objects to return from the search.
        See Also:
        getMaxObjects()

      • setBlockCount

        void setBlockCount​(int count)
        Sets the Block count.
        Parameters:
        count - int value indicating the page size for the search results

      • getBlockCount

        int getBlockCount()
        Returns:
        the maximum time that a search will wait before returning. For more information refer to the WebSearch object.

      • setPollingFrequency

        void setPollingFrequency​(int frequency)
        Sets the time that a search will will poll for the results. For more information refer to the WebSearch object.
        Parameters:
        frequency - the frequency that a search polls for results.

      • getPollingFrequency

        int getPollingFrequency()
        Returns:
        the time that a search will will poll for the results. For more information refer to the WebSearch object.

      • getFolderBean

        FolderBean getFolderBean()
        Returns:
        the FolderBean associates with this Bean.

      • getSearchID

        java.lang.String getSearchID()
        Returns the search ID of the last search submitted, or the last time setSearchID was called.
        Returns:
        The currently active search ID.
        See Also:
        setSearchID(java.lang.String)

      • setSearchID

        void setSearchID​(java.lang.String id)
        Sets the search ID.
        Parameters:
        id - The search ID of a search which is executing or has results waiting on the Intelligence Server.
        See Also:
        getSearchID()

      • getNamePattern

        java.lang.String getNamePattern()
        Returns the pattern to search for in the name of the objects in metadata.
        Returns:
        The name pattern that will be searched for.
        See Also:
        setNamePattern(java.lang.String)

      • setNamePattern

        void setNamePattern​(java.lang.String name)
        Sets the pattern to search for in the name of the objects in metadata.
        Parameters:
        name - The name pattern that will be searched for.
        See Also:
        getNamePattern()

      • getDateType

        int getDateType()
        Gets whether the search will be restricted based on dates.
        Returns:
        whether the search will be restricted based on dates.
        See Also:
        DATE_ALL_DATES, DATE_SPECIFIC_DATE

      • setDateType

        void setDateType​(int dataType)
        Sets whether the search will be restricted based on dates.
        Parameters:
        dataType - whether the search will be restricted based on dates.
        See Also:
        DATE_ALL_DATES, DATE_SPECIFIC_DATE

      • getDateSubType

        int getDateSubType()
        Gets whether the search will be restricted based on a time or date interval.
        Returns:
        whether the search will be restricted based on a time or date interval.
        See Also:
        DATE_BETWEEN_INTERVAL, DATE_BETWEEN_DATES

      • setDateSubType

        void setDateSubType​(int dateSubType)
        Sets whether the search will be restricted based on a time or date interval.
        Parameters:
        dateSubType - whether the search will be restricted based on a time or date interval.
        See Also:
        DATE_BETWEEN_INTERVAL, DATE_BETWEEN_DATES

      • getDateCreated

        int getDateCreated()
        Gets whether the search will be taken from the creation or modification time.
        Returns:
        value that specifies whether the search will be taken from the creation or modification time.
        See Also:
        DATE_CREATED, DATE_MODIFIED

      • setDateCreated

        void setDateCreated​(int dateCreated)
        Sets whether the search will be taken from the creation or modification time.
        Parameters:
        dateCreated - value that specifies whether the search will be taken from the creation or modification time.
        See Also:
        DATE_CREATED, DATE_MODIFIED

      • setIntervalUnit

        void setIntervalUnit​(int intervalUnit)
        Sets the time units to use if the search is restricted on a time interval.
        Parameters:
        intervalUnit - the time units used by the current search.
        See Also:
        DATE_HOURS, DATE_DAYS, DATE_WEEKS, DATE_MONTHS, DATE_YEARS

      • getIntervalValue

        java.lang.String getIntervalValue()
        Gets the time value to use if the search is restricted on a time interval. Possible values are positive integers.
        Returns:
        the time value that the current search will use.

      • setIntervalValue

        void setIntervalValue​(java.lang.String intervalValue)
        Sets the time value to use if the search is restricted on a time interval. Possible values are positive integers.
        Parameters:
        intervalValue - the time value the current search will use.

      • getStartDate

        java.lang.String getStartDate()
        Gets the start date if the search is restricted on a date interval. Possible values are valid dates.
        Returns:
        the start date of the interval.

      • setStartDate

        void setStartDate​(java.lang.String startDate)
        Sets the start date of a search restricted on a date interval.
        Parameters:
        startDate - A valid date which represents the start date of the interval.

      • getEndDate

        java.lang.String getEndDate()
        Gets the end date if the search is restricted on a date interval. Possible values are valid dates.
        Returns:
        the end date of the interval.

      • setEndDate

        void setEndDate​(java.lang.String endDate)
        Sets the end date of a search restricted on a date interval.
        Parameters:
        endDate - A valid date which represents the start date of the interval.

      • getOwnerType

        int getOwnerType()
        Gets the owner of the objects to search for.
        Returns:
        The owner of the objects to search for.
        See Also:
        OWNER_ALL, OWNER_CURRENT

      • setOwnerType

        void setOwnerType​(int ownerType)
        Sets the owner of the objects to search for.
        Parameters:
        ownerType - the owner of the objects to search for.
        See Also:
        OWNER_ALL, OWNER_CURRENT

      • getDescriptionPattern

        java.lang.String getDescriptionPattern()
        Returns the description pattern that the search is currently limited to. An empty string denotes that the search will not be limited by the description of the objects.
        Returns:
        The current description pattern to search for.
        See Also:
        setDescriptionPattern(java.lang.String)

      • setDescriptionPattern

        void setDescriptionPattern​(java.lang.String description)
        Sets the description pattern that the search will be limited to. An empty string denotes that the search will not be limited by the description of the objects.
        Parameters:
        description - The description pattern to use in the search.
        See Also:
        getDescriptionPattern()

      • getTypes

        SimpleListObj getTypes()
        Returns a SimpleListObj from which types can be added or removed. Note that the SimpleListObj returned can only have java.lang.Integer objects added to it.
        Returns:
        A SimpleListObj reflecting the types of objects which will be searched for.

      • setTypes

        void setTypes​(java.lang.String value)
        Allows the user to set the types restriction as a comma separated list of integers representing the types the search should be restricted to. Valid values are those defined in the EnumDSSXMLObjectTypes or the EnumDSSXMLObjectSubTypes enumerations.
        Since:
        MicroStrategy Web 9.0.0

      • getDomain

        int getDomain()
        Return the search domain, an enumeration value from EnumDSSXMLSearchDomain.
        Returns:
        the search domain.
        Since:
        MicroStrategy Web 9.0.0

      • setDomain

        void setDomain​(int domain)
        Sets the search domain, an enumeration value from EnumDSSXMLSearchDomain.
        Parameters:
        domain - the search domain.
        Since:
        MicroStrategy Web 9.0.0

      • isDerefrenceShortcut

        boolean isDerefrenceShortcut()
        Indicate whether DssXmlSearchDereferenceShortcut flag should be set for search, see
        Returns:
        the boolean value.
        Since:
        MicroStrategy Web 9.1.0

      • setDerefrenceShortcut

        void setDerefrenceShortcut​(boolean derefrenceShortcut)
        Set the DerefrenceShortcut property which indicate DssXmlSearchDereferenceShortcut flag for search, see
        Parameters:
        derefrenceShortcut - the boolean value.
        Since:
        MicroStrategy Web 9.1.0