SitePagesService (Alfresco Dataprep 1.13 API)

java.lang.Object
- org.alfresco.dataprep.SitePagesService

@Service
public class SitePagesService
extends Object

Constructor Summary

Constructors
Constructor and Description

SitePagesService()

Constructors
Constructor and Description
`SitePagesService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`addCalendarEvent(String userName, String password, String siteName, String what, String where, String description, Date startDate, Date endDate, String timeStart, String timeEnd, boolean allDay, String tag)` Add calendar event
`boolean`	`blogExists(String userName, String password, String siteName, String blogTitle, boolean draft)` Verify if blog post exists
`boolean`	`commentBlog(String userName, String password, String siteName, String blogTitle, boolean draft, String comment)` Add comment to blog
`boolean`	`commentLink(String userName, String password, String siteName, String linkTitle, String comment)` Add comment to link
`boolean`	`createBlogPost(String userName, String password, String siteName, String blogTitle, String content, boolean draft, List<String> tags)` Create a new blog post
`boolean`	`createDiscussion(String userName, String password, String siteName, String discussionTitle, String text, List<String> tags)` Create discussion topic
`boolean`	`createLink(String userName, String password, String siteName, String linkTitle, String url, String description, boolean internal, List<String> tags)` Create a new blog post
`boolean`	`createWiki(String userName, String password, String siteName, String wikiTitle, String content, List<String> tags)` Create a new wiki page
`boolean`	`deleteBlogComment(String userName, String password, String siteName, String blogTitle, String comment)` Delete a comment from a blog
`boolean`	`deleteBlogPost(String userName, String password, String siteName, String blogTitle, boolean isDraft)` Delete blog post
`boolean`	`deleteDiscussion(String userName, String password, String siteName, String discussionTitle)` Delete a discussion topic
`boolean`	`deleteLink(String userName, String password, String siteName, String linkTitle)` Delete link
`boolean`	`deleteLinkComment(String userName, String password, String siteName, String linkTitle, String comment)` Delete a comment from a link
`boolean`	`deleteWikiPage(String userName, String password, String siteName, String wikiTitle)` Delete wiki page
`boolean`	`discussionExists(String userName, String password, String siteName, String discussionTitle)` Verify if a discussion topic exists
`List<String>`	`getBlogComments(String userName, String password, String siteName, String blogTitle)` Get list of comments for a blog
`String`	`getBlogName(String userName, String password, String siteName, String blogTitle, boolean draft)` Get the name (id) of a blog post
`String`	`getCommentNodeRef(String userName, String password, String siteName, DashboardCustomization.Page page, String itemTitle, String comment)` Get a node ref for a comment added in blog or link page
`String`	`getDiscussionName(String userName, String password, String siteName, String discussionTitle)` Get the name(id) of a created topic
`List<String>`	`getDiscussionReplies(String userName, String password, String siteName, String discussionTitle)` Get a list of replies from a topic
`String`	`getEventName(String userName, String password, String siteName, String what, String where, Date from, Date to, String timeStart, String timeEnd, boolean allDay)` Get the name (ID) of the event
`List<String>`	`getLinkComments(String userName, String password, String siteName, String linkTitle)` Get list of comments for a link
`String`	`getLinkName(String userName, String password, String siteName, String linkTitle)` Get the name (id) of a link
`boolean`	`linkExists(String userName, String password, String siteName, String linkTitle)` Verify if link exists
`boolean`	`removeEvent(String userName, String password, String siteName, String what, String where, Date from, Date to, String timeStart, String timeEnd, boolean allDay)` Remove an event
`boolean`	`replyToDiscussion(String userName, String password, String siteName, String discussionTitle, String reply)` Add reply to topic
`boolean`	`updateBlogPost(String userName, String password, String siteName, String blogTitle, String newBlogTitle, String newBlogText, boolean isDraft)` Update blog post
`boolean`	`updateDiscussion(String userName, String password, String siteName, String discussionTitle, String newDiscussionTitle, String newText, List<String> newTags)` Update a discussion topic
`boolean`	`updateEvent(String userName, String password, String siteName, String eventName, String newWhat, String newWhere, Date newStartDate, Date newEndDate, String newTimeStart, String newTimeEnd, boolean newAllDay)` Update an event
`boolean`	`updateLink(String userName, String password, String siteName, String linkTitle, String newLinkTitle, String newUrl, String newDescription, boolean newInternal, List<String> newTags)` Update link
`boolean`	`updateWikiPage(String userName, String password, String siteName, String wikiTitle, String newWikiTitle, String newContent, List<String> newTags)` Update wiki page
`boolean`	`wikiExists(String userName, String password, String siteName, String wikiTitle)` Verify if wiki exists

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- SitePagesService
```
public SitePagesService()
```

Method Detail

addCalendarEvent

public boolean addCalendarEvent(String userName,
                                String password,
                                String siteName,
                                String what,
                                String where,
                                String description,
                                Date startDate,
                                Date endDate,
                                String timeStart,
                                String timeEnd,
                                boolean allDay,
                                String tag)

Add calendar event

Parameters:: userName - String user name; password - String user password; siteName - String site name; what - String what; where - String event location; description - String event description; startDate - Date event start date; endDate - Date event end date; timeStart - String event start time; timeEnd - String event time finish; allDay - boolean all day event; tag - String tag the event
Returns:: true if event is created

getEventName

public String getEventName(String userName,
                           String password,
                           String siteName,
                           String what,
                           String where,
                           Date from,
                           Date to,
                           String timeStart,
                           String timeEnd,
                           boolean allDay)

Get the name (ID) of the event

Parameters:: userName - String user name; password - String user password; siteName - String site name; what - String what; where - String event location; from - Date event start date; to - Date event end date; timeStart - String event start time; timeEnd - String event time finish; allDay - boolean all day event
Returns:: String name (id) of event

removeEvent

public boolean removeEvent(String userName,
                           String password,
                           String siteName,
                           String what,
                           String where,
                           Date from,
                           Date to,
                           String timeStart,
                           String timeEnd,
                           boolean allDay)

Remove an event

Parameters:: userName - String user name; password - String user password; siteName - String site name; what - String what; where - String event location; from - Date event start date; to - Date event end date; timeStart - String event start time; timeEnd - String event time finish; allDay - boolean all day event
Returns:: boolean true if event is removed
Throws:: RuntimeException - if site is not found

updateEvent

public boolean updateEvent(String userName,
                           String password,
                           String siteName,
                           String eventName,
                           String newWhat,
                           String newWhere,
                           Date newStartDate,
                           Date newEndDate,
                           String newTimeStart,
                           String newTimeEnd,
                           boolean newAllDay)

Update an event

Parameters:: userName - String user name; password - String user password; siteName - String site name; eventName - String even name to be updated should be returned by #getEventName(); newWhat - String new what; newWhere - String new event location; newStartDate - Date new event start date; newEndDate - Date new event end date; newTimeStart - String new event start time; newTimeEnd - String new event time finish; newAllDay - boolean new all day event
Returns:: boolean true if event is updated

createWiki

public boolean createWiki(String userName,
                          String password,
                          String siteName,
                          String wikiTitle,
                          String content,
                          List<String> tags)

Create a new wiki page

Parameters:: userName - String user name; password - String password; siteName - String site name; wikiTitle - String wiki title; content - String wiki content; tags - List of tags
Returns:: true if wiki page is created (200 Status)
Throws:: RuntimeException - if site not found

wikiExists

public boolean wikiExists(String userName,
                          String password,
                          String siteName,
                          String wikiTitle)

Verify if wiki exists

Parameters:: userName - String user name; password - String password; siteName - String site name; wikiTitle - String wiki title
Returns:: true if wiki exists (200 Status)

deleteWikiPage

public boolean deleteWikiPage(String userName,
                              String password,
                              String siteName,
                              String wikiTitle)

Delete wiki page

Parameters:: userName - String user name; password - String password; siteName - String site name; wikiTitle - String wiki title
Returns:: true if wiki is removed (204 Status)

updateWikiPage

public boolean updateWikiPage(String userName,
                              String password,
                              String siteName,
                              String wikiTitle,
                              String newWikiTitle,
                              String newContent,
                              List<String> newTags)

Update wiki page

Parameters:: userName - String user name; password - String password; siteName - String site name; wikiTitle - String wiki title to be updated; newWikiTitle - String new wiki title; newContent - String new wiki content; newTags - new list of tags
Returns:: true if wiki is updated (204 Status)

createBlogPost

public boolean createBlogPost(String userName,
                              String password,
                              String siteName,
                              String blogTitle,
                              String content,
                              boolean draft,
                              List<String> tags)

Create a new blog post

Parameters:: userName - String user name; password - String password; siteName - String site name; blogTitle - String blog title; content - String blog content; draft - boolean create blog as draft. If not it will be published; tags - List of tags
Returns:: true if blog post is created (200 Status)

getBlogName

public String getBlogName(String userName,
                          String password,
                          String siteName,
                          String blogTitle,
                          boolean draft)

Get the name (id) of a blog post

Parameters:: userName - String user name; password - String password; siteName - String site name; blogTitle - String blog title; isDraft - boolean is draft
Returns:: String name of blog post

blogExists

public boolean blogExists(String userName,
                          String password,
                          String siteName,
                          String blogTitle,
                          boolean draft)

Verify if blog post exists

Parameters:: userName - String user name; password - String password; siteName - String site name; blogTitle - String blog title; isDraft - boolean is draft
Returns:: boolean true if blog post exists

updateBlogPost

public boolean updateBlogPost(String userName,
                              String password,
                              String siteName,
                              String blogTitle,
                              String newBlogTitle,
                              String newBlogText,
                              boolean isDraft)

Update blog post

Parameters:: userName - String user name; password - String password; siteName - String site name; blogTitle - String blog title to be updated; newBlogTitle - String new blog title; newBlogText - String new blog text; isDraft - boolean is draft
Returns:: true if blog is updated (200 Status)

deleteBlogPost

public boolean deleteBlogPost(String userName,
                              String password,
                              String siteName,
                              String blogTitle,
                              boolean isDraft)

Delete blog post

Parameters:: userName - String user name; password - String password; siteName - String site name; blogTitle - String blog title; isDraft - boolean is draft
Returns:: true if blog is removed (200 Status)
Throws:: RuntimeException - if blog is not found

createLink

public boolean createLink(String userName,
                          String password,
                          String siteName,
                          String linkTitle,
                          String url,
                          String description,
                          boolean internal,
                          List<String> tags)

Create a new blog post

Parameters:: userName - String user name; password - String password; siteName - String site name; linkTitle - String link title; url - String link url; description - String link description; internal - boolean internal; tags - List of tags
Returns:: true if link is created (200 Status)
Throws:: RuntimeException - if site is not found

getLinkName

public String getLinkName(String userName,
                          String password,
                          String siteName,
                          String linkTitle)

Get the name (id) of a link

Parameters:: userName - String user name; password - String password; siteName - String site name; linkTitle - String blog title
Returns:: String name of blog post

linkExists

public boolean linkExists(String userName,
                          String password,
                          String siteName,
                          String linkTitle)

Verify if link exists

Parameters:: userName - String user name; password - String password; siteName - String site name; linkTitle - String blog title
Returns:: boolean true if link exists

deleteLink

public boolean deleteLink(String userName,
                          String password,
                          String siteName,
                          String linkTitle)

Delete link

Parameters:: userName - String user name; password - String password; siteName - String site name; linkTitle - String blog title
Returns:: true if link is removed (200 Status)

updateLink

public boolean updateLink(String userName,
                          String password,
                          String siteName,
                          String linkTitle,
                          String newLinkTitle,
                          String newUrl,
                          String newDescription,
                          boolean newInternal,
                          List<String> newTags)

Update link

Parameters:: userName - String user name; password - String password; siteName - String site name; linkTitle - String link title to be updated; newLinkTitle - String new link title; newUrl - String link new url; newDescription - String new link description; newInternal - boolean new internal; newTags - new List of tags
Returns:: true if link is updated (200 Status)

createDiscussion

public boolean createDiscussion(String userName,
                                String password,
                                String siteName,
                                String discussionTitle,
                                String text,
                                List<String> tags)

Create discussion topic

Parameters:: userName - String user name; password - String password; siteName - String site name; discussionTitle - String topic title; text - String topic content; tags - List tags
Returns:: true if topic is created
Throws:: RuntimeException - if site is not found

getDiscussionName

public String getDiscussionName(String userName,
                                String password,
                                String siteName,
                                String discussionTitle)

Get the name(id) of a created topic

Parameters:: userName - String user name; password - String password; siteName - String site name; discussionTitle - String discussion title
Returns:: String name (id) of the topic

discussionExists

public boolean discussionExists(String userName,
                                String password,
                                String siteName,
                                String discussionTitle)

Verify if a discussion topic exists

Parameters:: userName - String user name; password - String password; siteName - String site name; discussionTitle - String discussion title
Returns:: true if topic exists

updateDiscussion

public boolean updateDiscussion(String userName,
                                String password,
                                String siteName,
                                String discussionTitle,
                                String newDiscussionTitle,
                                String newText,
                                List<String> newTags)

Update a discussion topic

Parameters:: userName - String user name; password - String password; siteName - String site name; discussionTitle - String discussion title to be updated; newDiscussionTitle - String new title; newText - String new text; newTags - List new tags
Returns:: true if updated

deleteDiscussion

public boolean deleteDiscussion(String userName,
                                String password,
                                String siteName,
                                String discussionTitle)

Delete a discussion topic

Parameters:: userName - String user name; password - String password; siteName - String site name; discussionTitle - String discussion title
Returns:: true if deleted

getDiscussionReplies

public List<String> getDiscussionReplies(String userName,
                                         String password,
                                         String siteName,
                                         String discussionTitle)

Get a list of replies from a topic

Parameters:: userName - String user name; password - String password; siteName - String site name; discussionTitle - String discussion title
Returns:: List of replies

replyToDiscussion

public boolean replyToDiscussion(String userName,
                                 String password,
                                 String siteName,
                                 String discussionTitle,
                                 String reply)

Add reply to topic

Parameters:: userName - String user name; password - String password; siteName - String site name; discussionTitle - String topic title; reply - String reply to topic
Returns:: true if reply is added successfully

commentBlog

public boolean commentBlog(String userName,
                           String password,
                           String siteName,
                           String blogTitle,
                           boolean draft,
                           String comment)

Add comment to blog

Parameters:: userName - String user name; password - String password; siteName - String site name; blogTitle - String blog title; draft - boolean true if draft; comment - String comment to add
Returns:: true if comment is added

commentLink

public boolean commentLink(String userName,
                           String password,
                           String siteName,
                           String linkTitle,
                           String comment)

Add comment to link

Parameters:: userName - String user name; password - String password; siteName - String site name; linkTitle - String link title; comment - String comment
Returns:: true if comment is added

getBlogComments

public List<String> getBlogComments(String userName,
                                    String password,
                                    String siteName,
                                    String blogTitle)

Get list of comments for a blog

Parameters:: userName - String user name; password - String password; siteName - String site name; blogTitle - String blog title; draft - boolean if blog is draft
Returns:: List of comments

getLinkComments

public List<String> getLinkComments(String userName,
                                    String password,
                                    String siteName,
                                    String linkTitle)

Get list of comments for a link

Parameters:: userName - String user name; password - String password; siteName - String site name; linkTitle - String link title
Returns:: List of comments

getCommentNodeRef

public String getCommentNodeRef(String userName,
                                String password,
                                String siteName,
                                DashboardCustomization.Page page,
                                String itemTitle,
                                String comment)

Get a node ref for a comment added in blog or link page

Parameters:: userName - String user name; password - String password; siteName - String site name; page - Page page where the comment was created (Blog or Link); itemTitle - String title; comment - String comment
Returns:: String nodeRef of the comment

deleteBlogComment

public boolean deleteBlogComment(String userName,
                                 String password,
                                 String siteName,
                                 String blogTitle,
                                 String comment)

Delete a comment from a blog

Parameters:: userName - String user name; password - String password; siteName - String site name; blogTitle - String blog title; comment - String comment to delete
Returns:: true if deleted

deleteLinkComment

public boolean deleteLinkComment(String userName,
                                 String password,
                                 String siteName,
                                 String linkTitle,
                                 String comment)

Delete a comment from a link

Parameters:: userName - String user name; password - String password; siteName - String site name; linkTitle - String link title; comment - String comment to delete
Returns:: true if deleted

Class SitePagesService

Constructor Summary