com.adobe.cq.social.journal

Interface JournalEntry

public interface JournalEntry

JournalEntry represents a journal entry.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_PAR_NAME
static String	DEFAULT_TEXT
static String	FIELD_INDEX_CATEGORY_DATE
static String	FIELD_INDEX_CATEGORY_YEAR
static String	FIELD_INDEX_MODIFIED_DATE
static String	NODE_COMMENTS
static String	NODE_TEXT
static String	NODE_TRACKBACKS
static String	PROP_AUTHOR
static String	PROP_CREATED
static String	PROP_ID
static String	PROP_LASTMODIFIED
static String	PROP_LASTMODIFIEDBY
static String	PROP_LASTREPLICATED
static String	PROP_LASTREPLICATEDBY
static String	PROP_PUBLISHED
static String	PROP_TAGS
static String	PROP_TEXT
static String	PROP_TITLE
static String	TYPE_COMMENTS
static String	TYPE_PARSYS
static String	TYPE_TEXT
static String	TYPE_TITLE
static String	TYPE_TRACKBACKS

Method Summary

Methods

Modifier and Type	Method and Description
Resource	addAttachment(String name, Binary data, String contentType) Adds an attachment to the journal Entry.
Comment	addComment(String text, String author) Adds a comment to this journal entry sing the specified text.
void	addTrackback(String title, String excerpt, String url, String journalName, String ip) Adds a trackback to this journal entry.
int	countComments() Returns the number of comments (including comments to comments).
List<Resource>	getAttachments() Returns the paths to the attachments of this journal entry.
String	getAuthor() Returns the author of this journal entry.
Iterator<Comment>	getComments() Returns all comments (including comments to comments) to this journal entry in chronological order.
Resource	getContentResource() Returns the content resource of this journal entry.
Date	getDate() Returns the date this journal entry has been published on.
String	getEditUrl(SlingHttpServletRequest request) Returns the URL this journal entry can be edited at, or null if not available.
String	getFeedUrl() Returns the URL of the feed for this journal entry as absolute URL.
String	getFeedUrl(boolean absolute) Returns the URL of the feed for this journal entry.
String	getFullUrl() Returns the full URL of this journal entry, including scheme, server name and port.
String	getId() Returns the unique ID of this journal entry.
Journal	getJournal() Returns the journal this journal entry belongs to or null if no journal can be found.
Page	getPage() Returns the page associated with this journal entry.
Resource	getResource() Returns the resource associated with this journal entry.
Tag[]	getTags() Returns the tags associated with this journal entry.
String	getTagsAsHTML() Returns a comma-separated string of HTML links for the specified tags.
String	getTagsAsHTML(ResourceBundle resourceBundle) Returns a comma-separated string of HTML links for the specified tags.
String	getTagsAsString() Returns a comma-separated string of names the specified tags.
String	getText() Returns the text of this journal entry.
Comment	getTextComment() Returns the UGC comment comment node that has the entry details.
String	getTitle() Returns the title of this journal entry.
String	getTrackBackUrl() Returns the track back URL for this journal entry.
String	getUrl() Returns the server-local URL of this journal entry, omitting scheme, server name and port number.
boolean	hasAttachments() Returns true if this journal entry has one or more attachments.
boolean	hasComments() Returns true if this journal entry has one or more comments.
boolean	hasTag(String path) Returns true if this journal entry is filed under the tag at the specified path.
boolean	isDraft() Returns true if this journal entry is an unpublished draft.
boolean	isModified() Returns whether this journal entry has been modified and needs to be saved.
boolean	isPage() Returns true if this journal entry is a page that doesn't show up in the timeline of the journal, e.g.
void	removeAttachment(Resource attachment) Remove an attachment from the journal Entry.
void	save() Saves all changes made to this journal entry.
void	setAuthor(String author) Sets the author of this journal entry.
void	setDate(Date date) Sets the date this journal entry has been published on.
void	setId(String id) Sets the unique ID of this journal entry.
void	setTags(Tag[] tags) Sets the tags associated with this journal entry.
void	setText(String text) Sets the text of this journal entry.
void	setTitle(String title) Sets the title of this journal entry.

Field Detail

DEFAULT_TEXT

static final String DEFAULT_TEXT

See Also:

Constant Field Values

PROP_ID

static final String PROP_ID

See Also:

Constant Field Values

PROP_TITLE

static final String PROP_TITLE

See Also:

Constant Field Values

PROP_TEXT

static final String PROP_TEXT

See Also:

Constant Field Values

PROP_TAGS

static final String PROP_TAGS

See Also:

Constant Field Values

PROP_AUTHOR

static final String PROP_AUTHOR

See Also:

Constant Field Values

PROP_CREATED

static final String PROP_CREATED

See Also:

Constant Field Values

PROP_LASTMODIFIED

static final String PROP_LASTMODIFIED

See Also:

Constant Field Values

PROP_LASTMODIFIEDBY

static final String PROP_LASTMODIFIEDBY

See Also:

Constant Field Values

PROP_PUBLISHED

static final String PROP_PUBLISHED

See Also:

Constant Field Values

PROP_LASTREPLICATED

static final String PROP_LASTREPLICATED

See Also:

Constant Field Values

PROP_LASTREPLICATEDBY

static final String PROP_LASTREPLICATEDBY

See Also:

Constant Field Values

NODE_TEXT

static final String NODE_TEXT

See Also:

Constant Field Values

NODE_COMMENTS

static final String NODE_COMMENTS

See Also:

Constant Field Values

NODE_TRACKBACKS

static final String NODE_TRACKBACKS

See Also:

Constant Field Values

TYPE_TITLE

static final String TYPE_TITLE

See Also:

Constant Field Values

TYPE_TEXT

static final String TYPE_TEXT

See Also:

Constant Field Values

TYPE_COMMENTS

static final String TYPE_COMMENTS

See Also:

Constant Field Values

TYPE_TRACKBACKS

static final String TYPE_TRACKBACKS

See Also:

Constant Field Values

TYPE_PARSYS

static final String TYPE_PARSYS

See Also:

Constant Field Values

FIELD_INDEX_MODIFIED_DATE

static final String FIELD_INDEX_MODIFIED_DATE

See Also:

Constant Field Values

FIELD_INDEX_CATEGORY_DATE

static final String FIELD_INDEX_CATEGORY_DATE

See Also:

Constant Field Values

FIELD_INDEX_CATEGORY_YEAR

static final String FIELD_INDEX_CATEGORY_YEAR

See Also:

Constant Field Values

DEFAULT_PAR_NAME

static final String DEFAULT_PAR_NAME

See Also:

Constant Field Values

Method Detail

getId

String getId()

Returns the unique ID of this journal entry.

Returns:

The ID

setId

void setId(String id)

Sets the unique ID of this journal entry. Once set, the ID is immutable.

Parameters:

id - The ID

getTitle

String getTitle()

Returns the title of this journal entry.

Returns:

The title

setTitle

void setTitle(String title)

Sets the title of this journal entry.

Parameters:

title - The title

getContentResource

Resource getContentResource()

Returns the content resource of this journal entry.

Returns:

The content resource

getText

String getText()

Returns the text of this journal entry.

Returns:

The text

setText

void setText(String text)

Sets the text of this journal entry.

Parameters:

text - The text

getAuthor

String getAuthor()

Returns the author of this journal entry.

Returns:

The author

setAuthor

void setAuthor(String author)

Sets the author of this journal entry.

Parameters:

author - The author

getDate

Date getDate()

Returns the date this journal entry has been published on. If still unpublished, the date of the last modification, or finally the creation date will be used.

Returns:

The date

setDate

void setDate(Date date)

Sets the date this journal entry has been published on.

Parameters:

date - The date

getTags

Tag[] getTags()

Returns the tags associated with this journal entry.

Returns:

The tags

setTags

void setTags(Tag[] tags)

Sets the tags associated with this journal entry. Refer to the TagManager in order to retrieve and/or create tags.

Parameters:

tags - The tags

getTagsAsString

String getTagsAsString()

Returns a comma-separated string of names the specified tags.

Returns:

The tags as string

getTagsAsHTML

String getTagsAsHTML()

Returns a comma-separated string of HTML links for the specified tags.

Returns:

The tags as HTML

getTagsAsHTML

String getTagsAsHTML(ResourceBundle resourceBundle)

Returns a comma-separated string of HTML links for the specified tags.

Parameters:

resourceBundle - ResourceBundle to use for translations

Returns:

The tags as HTML

getAttachments

List<Resource> getAttachments()

Returns the paths to the attachments of this journal entry.

Returns:

The attachments

getComments

Iterator<Comment> getComments()

Returns all comments (including comments to comments) to this journal entry in chronological order.

Returns:

The comments

countComments

int countComments()

Returns the number of comments (including comments to comments). Comments are excluded from the count if they are marked as spam, or still unapproved in case comments are moderated.

Returns:

The number of comments

addComment

Comment addComment(String text,
                 String author)

Adds a comment to this journal entry sing the specified text.

Parameters:

text - The text

author - The author of the comment (optional)

Returns:

The comment

addTrackback

void addTrackback(String title,
                String excerpt,
                String url,
                String journalName,
                String ip)

Adds a trackback to this journal entry.

Parameters:

title - The title

excerpt - The excerpt of the trackback

journalName - The author's journalName

url - The URL of the author's website

ip - The ip of the author

getJournal

Journal getJournal()

Returns the journal this journal entry belongs to or null if no journal can be found.

Returns:

The journal

getResource

Resource getResource()

Returns the resource associated with this journal entry.

Returns:

The resource

getPage

Page getPage()

Returns the page associated with this journal entry.

Returns:

The page

getUrl

String getUrl()

Returns the server-local URL of this journal entry, omitting scheme, server name and port number.

Returns:

The URL

getFullUrl

String getFullUrl()

Returns the full URL of this journal entry, including scheme, server name and port.

Returns:

The full URL

getFeedUrl

String getFeedUrl()

Returns the URL of the feed for this journal entry as absolute URL. Same as getFeedUrl(true).

Returns:

The feed URL

getFeedUrl

String getFeedUrl(boolean absolute)

Returns the URL of the feed for this journal entry.

Parameters:

absolute - true if the URL should be absolute (http://server.com/journal), false if it should be relative (/journal)

Returns:

The feed URL

getTrackBackUrl

String getTrackBackUrl()

Returns the track back URL for this journal entry.

Returns:

The track back URL

getEditUrl

String getEditUrl(SlingHttpServletRequest request)

Returns the URL this journal entry can be edited at, or null if not available.

Parameters:

request - The request

Returns:

The edit URL

isPage

boolean isPage()

Returns true if this journal entry is a page that doesn't show up in the timeline of the journal, e.g. an "About" page.

Returns:

true if journal entry is a page, false otherwise

isDraft

boolean isDraft()

Returns true if this journal entry is an unpublished draft.

Returns:

true if journal entry is a draft, false otherwise

hasTag

boolean hasTag(String path)

Returns true if this journal entry is filed under the tag at the specified path.

Parameters:

path - the tag path

Returns:

true if journal entry has this tag, false otherwise

hasAttachments

boolean hasAttachments()

Returns true if this journal entry has one or more attachments.

Returns:

true if journal entry has attachments, false otherwise

hasComments

boolean hasComments()

Returns true if this journal entry has one or more comments.

Returns:

true if journal entry has comments, false otherwise

isModified

boolean isModified()

Returns whether this journal entry has been modified and needs to be saved.

Returns:

true if journal entry is modified, false otherwise

See Also:

save()

save

void save()
          throws JournalException

Saves all changes made to this journal entry. In case the journal entry doesn't exist yet, it will be created.

Throws:

JournalException - if saving fails

getTextComment

Comment getTextComment()

Returns the UGC comment comment node that has the entry details.

Returns:

The UGC comment node

addAttachment

Resource addAttachment(String name,
                     Binary data,
                     String contentType)

Adds an attachment to the journal Entry.

Parameters:

name - attachment name

data - binary data for the attachment

contentType - the mime type of the attachment

Returns:

the Resource of the newly added attachment

removeAttachment

void removeAttachment(Resource attachment)

Remove an attachment from the journal Entry.

Parameters:

attachment - the attachment to remove