com.atlassian.confluence.pages

Class Draft

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.pages.Draft

All Implemented Interfaces:

com.atlassian.bonnie.Searchable, Content, Addressable, ContentTypeAware, Versioned, EditableLabelable, Labelable, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class Draft
extends ContentEntityObject

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTENT_TYPE
static java.lang.String	NEW The content ID of a new piece of content, as a String.
static java.lang.Long	NEW_CONTENT_ID This is the placeholder id used in Drafts for new content.

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

CREATED, CURRENT, DELETED, MODIFIED

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

INITIAL_VERSION

Constructor Summary

Constructors

Constructor and Description
Draft()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
ContentEntityObject	getContentEntityObject()
java.lang.String	getContentSummary()
java.lang.String	getDraftSpaceKey()
java.lang.String	getDraftType()
java.lang.String	getNameForComparison() Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.
java.lang.String	getPageId() Gets the id of the AbstractPage which this is a draft of, as a String.
java.lang.Long	getPageIdAsLong()
int	getPageVersion()
java.lang.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.
java.lang.String	getUrlPath()
int	hashCode()
boolean	isBlank()
boolean	isIndexable() Content entity objects that are historical versions should not be indexed.
boolean	isNewPage() Returns true if the draft is for a new piece of content, otherwise false.
void	setDraftSpaceKey(java.lang.String draftSpaceKey)
void	setDraftType(java.lang.String draftType)
void	setPageId(java.lang.Long pageId)
void	setPageId(java.lang.String pageId)
void	setPageVersion(int pageVersion)
java.lang.String	toString()

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

addAttachment, addComment, addCustomContent, addOutgoingLink, addPermission, addReferralLink, addTrackbackLink, clone, compareTo, convertToHistoricalVersion, ensureAttachmentBelongsToContent, getAttachmentNamed, getAttachments, getAttachmentsUrlPath, getAttachmentUrlPath, getBodyAsString, getBodyAsStringWithoutMarkup, getBodyContent, getBodyContent, getBodyContents, getComments, getContentId, getContentPermission, getContentPermissionSet, getContentStatus, getDefaultBodyType, getDisplayTitle, getEntity, getExcerpt, getIdAsString, getLatestVersionsOfAttachments, getOutgoingLinks, getPermissions, getProperties, getReferralLinks, getRenderedVersionComment, getSearchableDependants, getTitle, getTrackbackLinks, getTypeEnum, getUserAccessor, getVersionComment, hasContentPermissions, hasPermissions, isCurrent, isDeleted, isRecentlyUpdatedFor, isVersionCommentAvailable, removeAttachment, removeComment, removeContentPermissionSet, removeCustomContent, removeOutgoingLink, removeReferralLink, removeTrackbackLink, replaceContentProperties, restore, restoreDependents, setAttachments, setBodyAsString, setBodyContent, setBodyContents, setComments, setContent, setContentStatus, setOutgoingLinks, setReferralLinks, setTitle, setTrackbackLinks, setUserAccessor, setVersionComment, toPageContext, trash, trashDependents

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

getLatestVersion, getOriginalVersion, getVersion, isLatestVersion, isNew, setOriginalVersion, 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

NEW

public static final java.lang.String NEW

The content ID of a new piece of content, as a String. There's also a Long form: NEW_CONTENT_ID.

See Also:

Constant Field Values

NEW_CONTENT_ID

public static final java.lang.Long NEW_CONTENT_ID

This is the placeholder id used in Drafts for new content. There's also a string form: NEW.

CONTENT_TYPE

public static final java.lang.String CONTENT_TYPE

See Also:

Constant Field Values

Constructor Detail

Draft

public Draft()

Method Detail

getContentEntityObject

public ContentEntityObject getContentEntityObject()

isNewPage

public boolean isNewPage()

Returns true if the draft is for a new piece of content, otherwise false.

getType

public java.lang.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

getNameForComparison

public java.lang.String getNameForComparison()

Description copied from class: ContentEntityObject

Subclasses should implement this method, giving a String back so that the content can be alphabetically sorted in a mixed-type list of content-entities.

Specified by:

getNameForComparison in class ContentEntityObject

getUrlPath

public java.lang.String getUrlPath()

Specified by:

getUrlPath in interface Addressable

Specified by:

getUrlPath in class ContentEntityObject

setPageVersion

public void setPageVersion(int pageVersion)

getPageVersion

public int getPageVersion()

getPageId

public java.lang.String getPageId()

Gets the id of the AbstractPage which this is a draft of, as a String. Note that it's currently stored as a String in the database, but the String always represents the id of a page, which is always representable as a long.

getPageIdAsLong

public java.lang.Long getPageIdAsLong()

setPageId

public void setPageId(java.lang.String pageId)

setPageId

public void setPageId(java.lang.Long pageId)

getDraftType

public java.lang.String getDraftType()

setDraftType

public void setDraftType(java.lang.String draftType)

toString

public java.lang.String toString()

Overrides:

toString in class ContentEntityObject

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class ContentEntityObject

hashCode

public int hashCode()

Overrides:

hashCode in class ContentEntityObject

getDraftSpaceKey

public java.lang.String getDraftSpaceKey()

setDraftSpaceKey

public void setDraftSpaceKey(java.lang.String draftSpaceKey)

isIndexable

public boolean isIndexable()

Description copied from class: ContentEntityObject

Content entity objects that are historical versions should not be indexed.

Specified by:

isIndexable in interface com.atlassian.bonnie.Searchable

Overrides:

isIndexable in class ContentEntityObject

isBlank

public boolean isBlank()

Returns:

true if this draft has a an empty title and content that is null or empty string

getContentSummary

public java.lang.String getContentSummary()