com.atlassian.confluence.content
Interface ContentEntityAdapter

All Known Implementing Classes:
DefaultContentAdapter, MailContentEntityAdapter

public interface ContentEntityAdapter

Class provided by a content type plugin to allow the resulting CustomContentEntityObject to return the right responses to various methods.

Methods that return Option represent an optional feature. If an adapter returns None from these methods, some default value will be used instead.


Method Summary
 com.atlassian.fugue.Option<String> getAttachmentsUrlPath(CustomContentEntityObject pluginContentEntityObject)
          Return the URL path to view the list of attachments on the content
 com.atlassian.fugue.Option<String> getAttachmentUrlPath(CustomContentEntityObject pluginContentEntityObject, Attachment attachment)
          Return the URL path to view the a particular attachment of the content
 BodyType getDefaultBodyType(CustomContentEntityObject pluginContentEntityObject)
          Get the default type for BodyContent objects attached to this content.
 com.atlassian.fugue.Option<String> getDisplayTitle(CustomContentEntityObject pluginContentEntityObject)
          Gets the display-friendly title for the content.
 com.atlassian.fugue.Option<String> getExcerpt(CustomContentEntityObject pluginContentEntityObject)
          Get a text-only summary of the content that is suitable for use in activity streams, search results and other places where a short placeholder for the content is necessary.
 com.atlassian.fugue.Option<String> getNameForComparison(CustomContentEntityObject pluginContentEntityObject)
          Return the sorting-friendly title for the content, if the content is to be sorted in alphabetical order.
 com.atlassian.fugue.Option<String> getUrlPath(CustomContentEntityObject pluginContentEntityObject)
          Gets the URL string (relative to the Confluence application context) at which this content can be viewed.
 

Method Detail

getUrlPath

com.atlassian.fugue.Option<String> getUrlPath(CustomContentEntityObject pluginContentEntityObject)
Gets the URL string (relative to the Confluence application context) at which this content can be viewed.

Parameters:
pluginContentEntityObject - the content to be viewed
Returns:
the relative URL path to that content, or none to use to the default

getDisplayTitle

com.atlassian.fugue.Option<String> getDisplayTitle(CustomContentEntityObject pluginContentEntityObject)
Gets the display-friendly title for the content. For example, a Comment does not have a title of its own, but where the UI needs to display the title of a comment, it uses "Re: Title Of Page Being Commented On".

Parameters:
pluginContentEntityObject - the content to calculate the display title for
Returns:
the display title of that content, or none to use to the default

getNameForComparison

com.atlassian.fugue.Option<String> getNameForComparison(CustomContentEntityObject pluginContentEntityObject)
Return the sorting-friendly title for the content, if the content is to be sorted in alphabetical order.

Parameters:
pluginContentEntityObject - the content to calculate the sorting title for
Returns:
the sorting title of that content, or none to use to the default

getAttachmentsUrlPath

com.atlassian.fugue.Option<String> getAttachmentsUrlPath(CustomContentEntityObject pluginContentEntityObject)
Return the URL path to view the list of attachments on the content

Parameters:
pluginContentEntityObject - the content to view attachments for
Returns:
the URL path to view attachments on the content, or none to use to the default

getAttachmentUrlPath

com.atlassian.fugue.Option<String> getAttachmentUrlPath(CustomContentEntityObject pluginContentEntityObject,
                                                        Attachment attachment)
Return the URL path to view the a particular attachment of the content

Parameters:
pluginContentEntityObject - the content to view attachments for
attachment - the attachment to link to
Returns:
the URL path to view attachments on the content, or none to use to the default

getDefaultBodyType

BodyType getDefaultBodyType(CustomContentEntityObject pluginContentEntityObject)
Get the default type for BodyContent objects attached to this content.

Parameters:
pluginContentEntityObject - the content to get the body type of
Returns:
the default BodyType for that content

getExcerpt

com.atlassian.fugue.Option<String> getExcerpt(CustomContentEntityObject pluginContentEntityObject)
Get a text-only summary of the content that is suitable for use in activity streams, search results and other places where a short placeholder for the content is necessary. The default implementation takes the first 255 characters of the content's main body with most markup characters removed.

Parameters:
pluginContentEntityObject - the content to excerpt
Returns:
the excerpt for that content, or none to use the default


Copyright © 2003-2013 Atlassian. All Rights Reserved.