|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.confluence.content.ContentEntityAdapterParent
public class ContentEntityAdapterParent
Default implementation of ContentEntityAdapter. Plugins should extend this class instead of implementing the interface directly so as not to be broken by changes to the interface.
Constructor Summary | |
---|---|
ContentEntityAdapterParent()
|
Method Summary | |
---|---|
com.atlassian.fugue.Option<java.lang.String> |
getAttachmentsUrlPath(CustomContentEntityObject pluginContentEntityObject)
Return the URL path to view the list of attachments on the content |
com.atlassian.fugue.Option<java.lang.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<java.lang.String> |
getDisplayTitle(CustomContentEntityObject pluginContentEntityObject)
Gets the display-friendly title for the content. |
com.atlassian.fugue.Option<java.lang.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<java.lang.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<java.lang.String> |
getUrlPath(CustomContentEntityObject pluginContentEntityObject)
Gets the URL string (relative to the Confluence application context) at which this content can be viewed. |
boolean |
isAllowedParent(CustomContentEntityObject child,
CustomContentEntityObject parent)
Determine if a particular content is an acceptable parent for this content. |
boolean |
isIndexable(CustomContentEntityObject pluginContentEntityObject,
boolean isDefaultIndexable)
Determine if a particular content should be indexed. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ContentEntityAdapterParent()
Method Detail |
---|
public com.atlassian.fugue.Option<java.lang.String> getUrlPath(CustomContentEntityObject pluginContentEntityObject)
ContentEntityAdapter
getUrlPath
in interface ContentEntityAdapter
pluginContentEntityObject
- the content to be viewed
public com.atlassian.fugue.Option<java.lang.String> getDisplayTitle(CustomContentEntityObject pluginContentEntityObject)
ContentEntityAdapter
getDisplayTitle
in interface ContentEntityAdapter
pluginContentEntityObject
- the content to calculate the display title for
public com.atlassian.fugue.Option<java.lang.String> getNameForComparison(CustomContentEntityObject pluginContentEntityObject)
ContentEntityAdapter
getNameForComparison
in interface ContentEntityAdapter
pluginContentEntityObject
- the content to calculate the sorting title for
public com.atlassian.fugue.Option<java.lang.String> getAttachmentsUrlPath(CustomContentEntityObject pluginContentEntityObject)
ContentEntityAdapter
getAttachmentsUrlPath
in interface ContentEntityAdapter
pluginContentEntityObject
- the content to view attachments for
public com.atlassian.fugue.Option<java.lang.String> getAttachmentUrlPath(CustomContentEntityObject pluginContentEntityObject, Attachment attachment)
ContentEntityAdapter
getAttachmentUrlPath
in interface ContentEntityAdapter
pluginContentEntityObject
- the content to view attachments forattachment
- the attachment to link to
public BodyType getDefaultBodyType(CustomContentEntityObject pluginContentEntityObject)
ContentEntityAdapter
getDefaultBodyType
in interface ContentEntityAdapter
pluginContentEntityObject
- the content to get the body type of
public com.atlassian.fugue.Option<java.lang.String> getExcerpt(CustomContentEntityObject pluginContentEntityObject)
ContentEntityAdapter
getExcerpt
in interface ContentEntityAdapter
pluginContentEntityObject
- the content to excerpt
public boolean isAllowedParent(CustomContentEntityObject child, CustomContentEntityObject parent)
ContentEntityAdapter
isAllowedParent
in interface ContentEntityAdapter
public boolean isIndexable(CustomContentEntityObject pluginContentEntityObject, boolean isDefaultIndexable)
ContentEntityAdapter
isIndexable
in interface ContentEntityAdapter
pluginContentEntityObject
- the entity to checkisDefaultIndexable
- if the entity would be indexed absent of this check.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |