ContentActions (Alfresco Dataprep 1.8 API)

java.lang.Object
- org.alfresco.dataprep.CMISUtil
- - org.alfresco.dataprep.ContentActions

@Service
public class ContentActions
extends CMISUtil

Nested Class Summary
- Nested classes/interfaces inherited from class org.alfresco.dataprep.CMISUtil
  CMISUtil.DocumentAspect, CMISUtil.DocumentType, CMISUtil.Priority, CMISUtil.Status

Field Summary
- Fields inherited from class org.alfresco.dataprep.CMISUtil
  alfrescoHttpClientFactory

Constructor Summary

Constructors
Constructor and Description

ContentActions()

Constructors
Constructor and Description
`ContentActions()`

Method Summary

All Methods Instance Methods Concrete Methods
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
`void`	`cancelCheckOut(String userName, String password, String siteId, String fileName)` If this is a PWC (private working copy) the check out will be reversed.
`org.apache.chemistry.opencmis.client.api.ObjectId`	`checkIn(String userName, String password, String siteId, String docName, CMISUtil.DocumentType fileType, String newContent, boolean majorVersion, String checkinComment)` Check in document.
`org.apache.chemistry.opencmis.client.api.ObjectId`	`checkOut(String userName, String password, String siteId, String fileName)` Checks out the document and returns the object id of the PWC (private working copy).
`org.apache.chemistry.opencmis.client.api.CmisObject`	`copyTo(String userName, String password, String sourceSite, String contentName, String targetSite, String targetFolder)` Copy file 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
`String`	`getVersion(String userName, String password, String siteId, String fileName)` Get the version of a file
`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
`org.apache.chemistry.opencmis.client.api.CmisObject`	`moveTo(String userName, String password, String sourceSite, String contentName, String targetSite, String targetFolder)` Move file 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.dataprep.CMISUtil
addAspect, addProperties, attachDocuments, closeStreams, getCategoryNodeRef, getCmisObject, getCMISSession, getDocumentObject, getFolderObject, getNodeRef, getNodeRef, getNodeRefByPath, getProperties, getPropertyValue, getUserNodeRef, 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)

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

addMultipleTags

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

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

getTagNamesFromContent

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

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

getTagNodeRef

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

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

removeTag

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

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

addComment

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

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

addMultipleComments

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

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

getComments

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

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

getCommentNodeRef

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

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

removeComment

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

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

likeContent

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

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

countLikes

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

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

removeLike

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

Remove like from content

Parameters:: userName - login username; password - login password; siteName - site name; contentName - file or folder name
Returns:: true if removed

setFileAsFavorite

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

Set a document as favorite

Parameters:: userName - login username; password - login password; siteName - site name; fileName - file name
Returns:: true if marked as favorite

setFolderAsFavorite

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

Set a folder as favorite

Parameters:: userName - login username; password - login password; siteName - site name; folderName - folder name
Returns:: true if marked as favorite

removeFavorite

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

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

isFavorite

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

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

checkOut

public org.apache.chemistry.opencmis.client.api.ObjectId checkOut(String userName,
                                                                  String password,
                                                                  String siteId,
                                                                  String fileName)

Checks out the document and returns the object id of the PWC (private working copy).

Parameters:: userName - login username; password - login password; siteId - site name; fileName - file
Returns:: ObjectId object id of PWC

cancelCheckOut

public void cancelCheckOut(String userName,
                           String password,
                           String siteId,
                           String fileName)

If this is a PWC (private working copy) the check out will be reversed. If this is not a PWC it an exception will be thrown.

Parameters:: userName - login username; password - login password; siteId - site name; fileName - file

checkIn

public org.apache.chemistry.opencmis.client.api.ObjectId checkIn(String userName,
                                                                 String password,
                                                                 String siteId,
                                                                 String docName,
                                                                 CMISUtil.DocumentType fileType,
                                                                 String newContent,
                                                                 boolean majorVersion,
                                                                 String checkinComment)

Check in document. If this is not a PWC(private working copy) check out for the file will be made.

Parameters:: userName - login username; password - login password; siteId - site name; docName - document name; fileType - DocumentType type of document; newContent - String new content to be set; majorVersion - boolean true to set major version; checkinComment - String check in comment
Returns:: ObjectId object id of PWC

getVersion

public String getVersion(String userName,
                         String password,
                         String siteId,
                         String fileName)

Get the version of a file

Parameters:: userName - login username; password - login password; siteId - site name; fileName - file
Returns:: String file version

copyTo

public org.apache.chemistry.opencmis.client.api.CmisObject copyTo(String userName,
                                                                  String password,
                                                                  String sourceSite,
                                                                  String contentName,
                                                                  String targetSite,
                                                                  String targetFolder)

Copy file or folder

Parameters:: userName - user name; password - password; siteName - source site; contentName - content to be copied; targetSite - tartget site; targetFolder - target folder. If null document library is set
Returns:: CmisObject of new created object

moveTo

public org.apache.chemistry.opencmis.client.api.CmisObject moveTo(String userName,
                                                                  String password,
                                                                  String sourceSite,
                                                                  String contentName,
                                                                  String targetSite,
                                                                  String targetFolder)

Move file or folder

Parameters:: userName - user name; password - password; siteName - source site; contentName - content to be copied; targetSite - tartget site; targetFolder - target folder. If null document library is set
Returns:: CmisObject of new created object

Class ContentActions

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.dataprep.CMISUtil

Field Summary

Fields inherited from class org.alfresco.dataprep.CMISUtil

Constructor Summary