Package com.atlassian.confluence.search.v2

Interface BaseSearchResult

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      String getField​(String fieldName)
      Returns the contents of the field as a string.
      Set<String> getFieldValues​(String fieldName)
      Return set of string values of a field of a given document, if the field has single value then return singleton set of that value, if there is no such field then return empty set.
      com.atlassian.bonnie.Handle getHandle()
      Retrieves the handle that can then be used by the AnyTypeDao to retrieve the database object referenced by this search result.
      boolean isFieldRequested​(String fieldName)
      Deprecated.
      since 5.9.

    • Method Detail

      • getHandle

        com.atlassian.bonnie.Handle getHandle()
        Retrieves the handle that can then be used by the AnyTypeDao to retrieve the database object referenced by this search result.

        Because the database and index are not updated at the same time, it is possible for a deleted entity to still be represented in the search index. Do not assume that this handle will always refer to a live object.

        Returns:
        the handle that can be used to look up the underlying database object.
        See Also:
        AnyTypeDao.findByHandle(com.atlassian.bonnie.Handle)

      • getField

        String getField​(String fieldName)
        Returns the contents of the field as a string. This method will return null if there is no content for the field or the field does not exist. FieldName is case sensitive.
        Parameters:
        fieldName -
        Returns:
        the field value or null.

      • getFieldValues

        Set<String> getFieldValues​(String fieldName)
        Return set of string values of a field of a given document, if the field has single value then return singleton set of that value, if there is no such field then return empty set.
        Parameters:
        fieldName -
        Returns:
        the field values or null.
        Since:
        5.10

      • isFieldRequested

        @Deprecated
boolean isFieldRequested​(String fieldName)
        Deprecated.
        since 5.9.
        check to see if this SearchFieldName has been requested during the search, if this method returns false then getField will throw a FieldNotRequestedException
        Parameters:
        fieldName -
        Returns: