com.atlassian.confluence.search.contentnames
Class SearchResult

java.lang.Object
  com.atlassian.confluence.search.contentnames.SearchResult

public class SearchResult
extends java.lang.Object

Represents a search result from a content name search.

Constructor Summary

SearchResult(java.lang.String name, java.lang.String url, java.lang.String contentType)

SearchResult(java.lang.String name, java.lang.String url, java.lang.String contentType, java.lang.String previewKey, Category category)

Method Summary

Category	getCategory()
java.lang.String	getContentType()
java.lang.String	getName()
java.lang.String	getPreviewKey() The previewKey property provides information a client can use to show a relevant preview/icon for this result.
java.lang.String	getSpaceKey()
java.lang.String	getSpaceName()
java.lang.String	getUrl()
void	setCategory(Category category)
void	setContentType(java.lang.String contentType)
void	setName(java.lang.String name)
void	setPreviewKey(java.lang.String previewKey)
void	setSpaceKey(java.lang.String spaceKey)
void	setSpaceName(java.lang.String spaceName)
void	setUrl(java.lang.String url)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SearchResult

public SearchResult(java.lang.String name,
                    java.lang.String url,
                    java.lang.String contentType)

SearchResult

public SearchResult(java.lang.String name,
                    java.lang.String url,
                    java.lang.String contentType,
                    java.lang.String previewKey,
                    Category category)

Method Detail

getName

public java.lang.String getName()

getUrl

public java.lang.String getUrl()

getContentType

public java.lang.String getContentType()

getPreviewKey

public java.lang.String getPreviewKey()

The previewKey property provides information a client can use to show a relevant preview/icon for this result. For example, when the result represents an Attachment the previewKey will contain it's mime type (if it has one). If the result represents a PersonalInformation then the previewKey will contain the username.

Returns:

information about this result that can be used to find the preview information that may be shown for this result.

getCategory

public Category getCategory()

getSpaceName

public java.lang.String getSpaceName()

getSpaceKey

public java.lang.String getSpaceKey()

setName

public void setName(java.lang.String name)

setUrl

public void setUrl(java.lang.String url)

setContentType

public void setContentType(java.lang.String contentType)

setPreviewKey

public void setPreviewKey(java.lang.String previewKey)

setCategory

public void setCategory(Category category)

setSpaceName

public void setSpaceName(java.lang.String spaceName)

setSpaceKey

public void setSpaceKey(java.lang.String spaceKey)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object