com.atlassian.confluence.search.contentnames

Class SearchResult

java.lang.Object

com.atlassian.confluence.search.contentnames.SearchResult

public class SearchResult
extends Object

Represents a search result from a content name search.

Constructor Summary

Constructors

Constructor and Description
SearchResult(Long id, String name, String url, String contentType)

Method Summary

Modifier and Type	Method and Description
Category	getCategory()
String	getContentPluginKey()
String	getContentType()
Date	getCreatedDate()
String	getCreator() Deprecated. since 5.2. Usernames should not be used as keys. Please use getCreator() instead.
ConfluenceUser	getCreatorUser() Returns the creator of this result.
Long	getId()
Date	getLastModifiedDate()
String	getLastModifier() Deprecated. since 5.2. Usernames should not be used as keys. Please use getLastModifier() instead.
ConfluenceUser	getLastModifierUser() Returns the last modifier of this result.
String	getName()
String	getOwnerType()
String	getParentTitle()
String	getPreviewKey() The previewKey property provides information a client can use to show a relevant preview/icon for this result.
String	getSpaceKey()
String	getSpaceName()
String	getUrl()
String	getUsername()
void	setCategory(Category category)
void	setContentPluginKey(String contentPluginKey)
void	setContentType(String contentType)
void	setCreatedDate(Date createdDate)
void	setCreatorKey(com.atlassian.sal.api.user.UserKey creatorKey)
void	setLastModifiedDate(Date lastModifiedDate)
void	setLastModifierKey(com.atlassian.sal.api.user.UserKey lastModifierKey)
void	setName(String name)
void	setOwnerType(String ownerType)
void	setParentTitle(String parentTitle)
void	setPreviewKey(String previewKey)
void	setSpaceKey(String spaceKey)
void	setSpaceName(String spaceName)
void	setUrl(String url)
void	setUsername(String username)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchResult

public SearchResult(Long id,
                    String name,
                    String url,
                    String contentType)

Method Detail

getId

public Long getId()

getName

public String getName()

getUrl

public String getUrl()

getContentType

public String getContentType()

getPreviewKey

public 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 String getSpaceName()

getSpaceKey

public String getSpaceKey()

getOwnerType

public String getOwnerType()

getCreatedDate

public Date getCreatedDate()

getLastModifiedDate

public Date getLastModifiedDate()

getParentTitle

public String getParentTitle()

setName

public void setName(String name)

setUrl

public void setUrl(String url)

setContentType

public void setContentType(String contentType)

setPreviewKey

public void setPreviewKey(String previewKey)

setCategory

public void setCategory(Category category)

setSpaceName

public void setSpaceName(String spaceName)

setSpaceKey

public void setSpaceKey(String spaceKey)

setOwnerType

public void setOwnerType(String ownerType)

setCreatedDate

public void setCreatedDate(Date createdDate)

setLastModifiedDate

public void setLastModifiedDate(Date lastModifiedDate)

setParentTitle

public void setParentTitle(String parentTitle)

setContentPluginKey

public void setContentPluginKey(String contentPluginKey)

getContentPluginKey

public String getContentPluginKey()

getCreator

@Deprecated
public String getCreator()

Deprecated. since 5.2. Usernames should not be used as keys. Please use getCreator() instead.

Returns the username of the creator of this result.

Returns:

username of the creator of this result

getCreatorUser

public ConfluenceUser getCreatorUser()

Returns the creator of this result.

Returns:

creator of this result

Since:

5.2

setCreatorKey

public void setCreatorKey(com.atlassian.sal.api.user.UserKey creatorKey)

Since:

5.2

getLastModifier

@Deprecated
public String getLastModifier()

Deprecated. since 5.2. Usernames should not be used as keys. Please use getLastModifier() instead.

Returns the username of the last modifier of this result.

Returns:

username of the last modifier of this result

getLastModifierUser

public ConfluenceUser getLastModifierUser()

Returns the last modifier of this result.

Returns:

last modifier of this result

Since:

5.2

setLastModifierKey

public void setLastModifierKey(com.atlassian.sal.api.user.UserKey lastModifierKey)

getUsername

public String getUsername()

setUsername

public void setUsername(String username)

toString

public String toString()

Overrides:

toString in class Object