Package org.sakaiproject.search.api

Interface SearchResult

  • public interface SearchResult
    Author:
    ieb

    • Method Detail

      • getScore

        float getScore()
        the result score
        Returns:

      • getId

        String getId()
        The result ID (entity id)
        Returns:

      • getFieldNames

        String[] getFieldNames()
        All field names in the search record
        Returns:

      • getValues

        String[] getValues​(String string)
        All values in a search field
        Parameters:
        string -
        Returns:

      • getValueMap

        Map<String,​String[]> getValueMap()
        Get a map of values in the result
        Returns:

      • getUrl

        String getUrl()
        An absolute URL to the resource (no host, protocol or port)
        Returns:

      • getTitle

        String getTitle()
        The title of the resource, usually including the type (eg Wiki Page, Resource)
        Returns:

      • getIndex

        int getIndex()
        get the index of the search entry over the whole change set
        Returns:

      • getSearchResult

        String getSearchResult()
        get the search result content for display

      • getReference

        String getReference()
        get the Sakai Entity Reference String
        Returns:

      • getTool

        String getTool()
        get the tool name that this search cam from
        Returns:

      • isCensored

        boolean isCensored()
        Has this item been censored by a filter?
        Returns:

      • getSiteId

        String getSiteId()

      • getCreatorDisplayName

        String getCreatorDisplayName()
        Get the display name of the user that created this indexed content

      • getCreatorId

        String getCreatorId()
        Get the display name of the user that created this indexed content

      • getCreatorUserName

        String getCreatorUserName()
        Get the username of the user that created this indexed content

      • setUrl

        void setUrl​(String newUrl)
        Set the Url - needed for tols that generate portal urls
        Parameters:
        newUrl -

      • hasPortalUrl

        boolean hasPortalUrl()
        This result has a ULR that displays within the portal
        Returns: