org.alfresco.dataprep

Class SitePagesService

java.lang.Object

org.alfresco.dataprep.SitePagesService

@Service
public class SitePagesService
extends Object

Constructor Summary

Constructors

Constructor and Description
SitePagesService()

Method Summary

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	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	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	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
String	getBlogName(String userName, String password, String siteName, String blogTitle, boolean draft) Get the name (id) of a blog post
String	getDiscussionName(String userName, String password, String siteName, String discussionTitle) Get the name(id) of a created 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
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	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)
                         throws Exception

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

Throws:

Exception - if error

getEventName

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

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

Throws:

Exception - if error

removeEvent

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

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:

Exception - if error

createWiki

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

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:

Exception - if error

wikiExists

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

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)

Throws:

Exception - if error

deleteWikiPage

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

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)

Throws:

Exception - if error

createBlogPost

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

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)

Throws:

Exception - if error

getBlogName

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

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

Throws:

Exception - if error

blogExists

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

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

Throws:

Exception - if error

deleteBlogPost

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

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:

Exception - if error

createLink

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

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:

Exception - if error

getLinkName

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

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

Throws:

Exception - if error

linkExists

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

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

Throws:

Exception - if error

deleteLink

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

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)

Throws:

Exception - if error

createDiscussion

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

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:

Exception

getDiscussionName

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

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

Throws:

Exception - if error

discussionExists

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

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

Throws:

Exception - if error

deleteDiscussion

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

Delete a discussion topic

Parameters:

userName - String user name

password - String password

siteName - String site name

discussionTitle - String discussion title

Returns:

true if deleted

Throws:

Exception - if error