com.atlassian.confluence.pages

Class BlogPost

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.confluence.core.ConfluenceEntityObject

com.atlassian.confluence.core.AbstractVersionedEntityObject

com.atlassian.confluence.core.AbstractLabelableEntityObject

com.atlassian.confluence.core.ContentEntityObject

com.atlassian.confluence.core.SpaceContentEntityObject

com.atlassian.confluence.pages.AbstractPage

com.atlassian.confluence.pages.BlogPost

All Implemented Interfaces:

com.atlassian.bonnie.Searchable, Content, Addressable, ContentTypeAware, HasLinkWikiMarkup, Versioned, RelatableEntity, EditableLabelable, Labelable, ContentConvertible, Spaced, Serializable, Cloneable, Comparable

public class BlogPost
extends AbstractPage
implements ContentConvertible

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTENT_TYPE
static String	POSTING_DATE Name of the form field used to store the posting date of the blog post
static String	POSTING_DAY_FORMAT

Fields inherited from class com.atlassian.confluence.core.ContentEntityObject

CREATED, CURRENT, DELETED, DRAFT, MODIFIED, SHARE_ID, SYNC_REV

Fields inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

INITIAL_VERSION

Fields inherited from interface com.atlassian.confluence.content.Content

UNSET

Constructor Summary

Constructors

Constructor and Description
BlogPost()

Method Summary

Modifier and Type	Method and Description
static Calendar	getCalendarFromDatePath(String datePath) BEFORE USING THIS - consider if BlogPostReference better suits your needs.
ContentId	getContentId() Returns the ContentId for this Blog post.
ContentType	getContentTypeObject()
String	getDatePath()
String	getLinkPart()
String	getLinkWikiMarkup()
Calendar	getPostingCalendarDate()
Date	getPostingDate() Alias for EntityObject.getCreationDate()
String	getPostingDayOfMonth()
String	getPostingMonth()
String	getPostingMonth(DateFormatter formatter)
String	getPostingMonthNumeric()
String	getPostingYear()
static String	getTitleFromDatePath(String datePath) BEFORE USING THIS - consider if BlogPostReference better suits your needs.
String	getType() An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.
boolean	shouldConvertToContent()
static Calendar	toCalendar(Date date)
static String	toDatePath(Date date)

Methods inherited from class com.atlassian.confluence.pages.AbstractPage

convertToHistoricalVersion, getAttachmentsUrlPath, getAttachmentUrlPath, getLatestVersion, getOriginalVersionPage, getPageLevelComments, getPreviousVersion, getSearchableDependants, getTopLevelComments, getUrlPath, hasInvalidTitleCharacters, isValidPageTitle, isValidPageTitleCharacter, isValidTitleLength, remove, setContentPropertiesFromDraft, setOriginalVersionPage, setTitle

Methods inherited from class com.atlassian.confluence.core.SpaceContentEntityObject

getNameForComparison, getSpace, getSpaceKey, hashCode, isIndexable, isInSpace, setSpace

Methods inherited from class com.atlassian.confluence.core.ContentEntityObject

addAttachment, addComment, addCustomContent, addOutgoingLink, addPermission, addReferralLink, addTrackbackLink, applyChildVersioningPolicy, clone, compareTo, ensureAttachmentBelongsToContent, equals, getAttachmentNamed, getAttachments, getBodyAsString, getBodyAsStringWithoutMarkup, getBodyContent, getBodyContent, getBodyContents, getComments, getContainerContent, getContentEntityObject, getContentPermission, getContentPermissionSet, getContentStatus, getContentStatusObject, getDefaultBodyType, getDisplayTitle, getEntity, getExcerpt, getIdAsString, getLatestVersionId, getLatestVersionsOfAttachments, getOriginalVersionId, getOutgoingLinks, getPermissions, getProperties, getReferralLinks, getRenderedVersionComment, getShareId, getTitle, getTrackbackLinks, getTypeEnum, getUserAccessor, getVersionComment, hasContentPermissions, hasPermissions, isCurrent, isDeleted, isDraft, isRecentlyUpdatedFor, isUnpublished, isVersionCommentAvailable, removeAttachment, removeComment, removeContentPermissionSet, removeCustomContent, removeOutgoingLink, removeReferralLink, removeTrackbackLink, replaceContentProperties, restore, restoreDependents, setAttachments, setBodyAsString, setBodyContent, setBodyContents, setComments, setContainerContent, setContentPropertiesFrom, setContentStatus, setOriginalVersion, setOriginalVersionId, setOutgoingLinks, setReferralLinks, setTrackbackLinks, setUserAccessor, setVersionComment, sharedAccessAllowed, toPageContext, toString, trash, trashDependents, wasCreatedBy

Methods inherited from class com.atlassian.confluence.core.AbstractLabelableEntityObject

addLabelling, getGlobalLabels, getLabelCount, getLabellings, getLabels, getLabelsForDisplay, getLabelUtil, getPersonalLabels, getTeamLabels, getVisibleLabels, isFavourite, isFavourite, removeLabelling, setLabellings

Methods inherited from class com.atlassian.confluence.core.AbstractVersionedEntityObject

getOriginalVersion, getVersion, getVersionChildPolicy, isLatestVersion, isNew, setVersion

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject

getCreationDate, getCurrentDate, getId, getLastModificationDate, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.atlassian.bonnie.Searchable

getId

Methods inherited from interface com.atlassian.confluence.core.Addressable

getId

Methods inherited from interface com.atlassian.confluence.labels.EditableLabelable

getId, isPersistent

Field Detail

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

POSTING_DAY_FORMAT

public static final String POSTING_DAY_FORMAT

See Also:

Constant Field Values

POSTING_DATE

public static final String POSTING_DATE

Name of the form field used to store the posting date of the blog post

See Also:

Constant Field Values

Constructor Detail

BlogPost

public BlogPost()

Method Detail

getType

public String getType()

Description copied from class: ContentEntityObject

An easy name for the type of this content: makes it easy for things like the #contentLink macro to work out what to draw.

This is a bit of a hack, but it saves heaps of code elsewhere, especially since we tend to get back these objects wrapped in all sorts of Hibernate CGLIB stuff.

Specified by:

getType in interface ContentTypeAware

Specified by:

getType in class ContentEntityObject

Returns:

the content type

toCalendar

public static Calendar toCalendar(Date date)

getCalendarFromDatePath

public static Calendar getCalendarFromDatePath(String datePath)

BEFORE USING THIS - consider if BlogPostReference better suits your needs.

Parameters:

datePath - - should resemble /2005/11/12/aBlogTitle

Returns:

Calendar representing the date of the blog, useful for a call to pageManager.getBlogPost(spaceKey, title, calendarDay)

getTitleFromDatePath

public static String getTitleFromDatePath(String datePath)

BEFORE USING THIS - consider if BlogPostReference better suits your needs.

Parameters:

datePath - - should resemble /2010/11/12/aBlogTitle

Returns:

the title of the blog, if supplied with correct input, otherwise a null

getLinkPart

public String getLinkPart()

getDatePath

public String getDatePath()

toDatePath

public static String toDatePath(Date date)

getLinkWikiMarkup

public String getLinkWikiMarkup()

Specified by:

getLinkWikiMarkup in interface HasLinkWikiMarkup

Returns:

the wiki markup used to link to this content

getPostingYear

public String getPostingYear()

getPostingMonth

public String getPostingMonth()

getPostingMonth

public String getPostingMonth(DateFormatter formatter)

getPostingMonthNumeric

public String getPostingMonthNumeric()

getPostingDayOfMonth

public String getPostingDayOfMonth()

getPostingDate

public Date getPostingDate()

Alias for EntityObject.getCreationDate()

Returns:

the posting date

getPostingCalendarDate

public Calendar getPostingCalendarDate()

getContentTypeObject

public ContentType getContentTypeObject()

Specified by:

getContentTypeObject in interface ContentConvertible

Returns:

the api ContentType that this ContentConvertible converts to

getContentId

public ContentId getContentId()

Returns the ContentId for this Blog post.

Specified by:

getContentId in interface ContentConvertible

Overrides:

getContentId in class ContentEntityObject

Returns:

the ContentId representation of this Blog post's id

shouldConvertToContent

public boolean shouldConvertToContent()

Specified by:

shouldConvertToContent in interface ContentConvertible

Returns:

true if the implementer wants to be part of the core API (default value), false otherwise