org.alfresco.test.util

Class ContentActions

java.lang.Object

org.alfresco.test.util.CMISUtil

org.alfresco.test.util.ContentActions

public class ContentActions
extends CMISUtil

Class to manage different content actions (tagging, comments, likes, favorites)

Author:

Bogdan Bocancea

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.test.util.CMISUtil

CMISUtil.DocumentAspect, CMISUtil.DocumentType

Field Summary

Fields inherited from class org.alfresco.test.util.CMISUtil

alfrescoHttpClientFactory

Constructor Summary

Constructors

Constructor and Description
ContentActions()

Method Summary

Modifier and Type	Method and Description
boolean	addComment(String userName, String password, String siteName, String contentName, String comment) Create a comment for a document or folder
boolean	addMultipleComments(String userName, String password, String siteName, String contentName, List<String> comments) Create multiple comments for a document or folder
boolean	addMultipleTags(String userName, String password, String siteName, String contentName, List<String> tags) Create multiple tags for document or folder
boolean	addSingleTag(String userName, String password, String siteName, String contentName, String tag) Create tag for a document or folder
int	countLikes(String userName, String password, String siteName, String contentName) Get the number of likes for a document or folder
String	getCommentNodeRef(String userName, String password, String siteName, String contentName, String comment) Get the node ref for comment
List<String>	getComments(String userName, String password, String siteName, String contentName) Get list of comments that are set for a document or folder
List<String>	getTagNamesFromContent(String userName, String password, String siteName, String contentName) Get list of tag names that are set for a document or folder
String	getTagNodeRef(String userName, String password, String siteName, String contentName, String tagName) Get the node ref from a tag
boolean	isFavorite(String userName, String password, String siteName, String contentName) Verify if a document or folder is marked as favorite
boolean	likeContent(String userName, String password, String siteName, String contentName) Like a document or folder
boolean	removeComment(String userName, String password, String siteName, String contentName, String comment) Remove comment from content
boolean	removeFavorite(String userName, String password, String siteName, String contentName) Remove favorite from document or folder
boolean	removeLike(String userName, String password, String siteName, String contentName) Remove like from content
boolean	removeTag(String userName, String password, String siteName, String contentName, String tagName) Remove tag from content
boolean	setFileAsFavorite(String userName, String password, String siteName, String fileName) Set a document as favorite
boolean	setFolderAsFavorite(String userName, String password, String siteName, String folderName) Set a folder as favorite

Methods inherited from class org.alfresco.test.util.CMISUtil

addAspect, addProperties, getCategoryNodeRef, getCMISSession, getNodeRef, getProperties, getPropertyValue, getValues, waitInSeconds

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ContentActions

public ContentActions()

Method Detail

addSingleTag

public boolean addSingleTag(String userName,
                            String password,
                            String siteName,
                            String contentName,
                            String tag)
                     throws Exception

Create tag for a document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

tag - tag for file or folder

Returns:

true if request is successful

Throws:

Exception - if error

addMultipleTags

public boolean addMultipleTags(String userName,
                               String password,
                               String siteName,
                               String contentName,
                               List<String> tags)
                        throws Exception

Create multiple tags for document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

tags - list of tags for a file or folder

Returns:

true if request is successful

Throws:

Exception - if error

getTagNamesFromContent

public List<String> getTagNamesFromContent(String userName,
                                           String password,
                                           String siteName,
                                           String contentName)
                                    throws Exception

Get list of tag names that are set for a document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

Returns:

List list of tags for a file or folder

Throws:

Exception - if error

getTagNodeRef

public String getTagNodeRef(String userName,
                            String password,
                            String siteName,
                            String contentName,
                            String tagName)
                     throws Exception

Get the node ref from a tag

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

tagName - tag of a file of folder

Returns:

String nodeRef

Throws:

Exception - if error

removeTag

public boolean removeTag(String userName,
                         String password,
                         String siteName,
                         String contentName,
                         String tagName)
                  throws Exception

Remove tag from content

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

tagName - tag of a file or folder

Returns:

true if deleted

Throws:

Exception - if error

addComment

public boolean addComment(String userName,
                          String password,
                          String siteName,
                          String contentName,
                          String comment)
                   throws Exception

Create a comment for a document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

comment - comment for a file or folder

Returns:

true if request is successful

Throws:

Exception - if error

addMultipleComments

public boolean addMultipleComments(String userName,
                                   String password,
                                   String siteName,
                                   String contentName,
                                   List<String> comments)
                            throws Exception

Create multiple comments for a document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

comments - list of comments

Returns:

true if request is successful

Throws:

Exception - if error

getComments

public List<String> getComments(String userName,
                                String password,
                                String siteName,
                                String contentName)
                         throws Exception

Get list of comments that are set for a document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

Returns:

List list of comments

Throws:

Exception - if error

getCommentNodeRef

public String getCommentNodeRef(String userName,
                                String password,
                                String siteName,
                                String contentName,
                                String comment)
                         throws Exception

Get the node ref for comment

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

comment - comment of a file or folder

Returns:

String nodeRef

Throws:

Exception - if error

removeComment

public boolean removeComment(String userName,
                             String password,
                             String siteName,
                             String contentName,
                             String comment)
                      throws Exception

Remove comment from content

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

comment - comment of a file or folder

Returns:

true if deleted

Throws:

Exception - if error

likeContent

public boolean likeContent(String userName,
                           String password,
                           String siteName,
                           String contentName)
                    throws Exception

Like a document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

Returns:

true if request is successful

Throws:

Exception - if error

countLikes

public int countLikes(String userName,
                      String password,
                      String siteName,
                      String contentName)
               throws Exception

Get the number of likes for a document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

Returns:

int likes

Throws:

Exception - if error

removeLike

public boolean removeLike(String userName,
                          String password,
                          String siteName,
                          String contentName)
                   throws Exception

Remove like from content

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

Returns:

true if removed

Throws:

Exception - if error

setFileAsFavorite

public boolean setFileAsFavorite(String userName,
                                 String password,
                                 String siteName,
                                 String fileName)
                          throws Exception

Set a document as favorite

Parameters:

userName - login username

password - login password

siteName - site name

fileName - file name

Returns:

true if marked as favorite

Throws:

Exception - if error

setFolderAsFavorite

public boolean setFolderAsFavorite(String userName,
                                   String password,
                                   String siteName,
                                   String folderName)
                            throws Exception

Set a folder as favorite

Parameters:

userName - login username

password - login password

siteName - site name

folderName - folder name

Returns:

true if marked as favorite

Throws:

Exception - if error

removeFavorite

public boolean removeFavorite(String userName,
                              String password,
                              String siteName,
                              String contentName)
                       throws Exception

Remove favorite from document or folder

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

Returns:

true if favorite is removed

Throws:

Exception - if error

isFavorite

public boolean isFavorite(String userName,
                          String password,
                          String siteName,
                          String contentName)
                   throws Exception

Verify if a document or folder is marked as favorite

Parameters:

userName - login username

password - login password

siteName - site name

contentName - file or folder name

Returns:

true if marked as favorite

Throws:

Exception - if error