Package org.alfresco.rest.v0

Class RecordFoldersAPI

java.lang.Object

org.alfresco.rest.core.v0.BaseAPI

org.alfresco.rest.v0.RecordFoldersAPI

@Component
public class RecordFoldersAPI
extends BaseAPI

Methods to make API requests using v0 API on records folders

Since:

2.5

Author:

Oana Nechiforescu

Nested Class Summary

Nested classes/interfaces inherited from class org.alfresco.rest.core.v0.BaseAPI

BaseAPI.PermissionType, BaseAPI.RETENTION_SCHEDULE, BaseAPI.RM_ACTIONS, BaseAPI.RMProperty

Field Summary

Fields inherited from class org.alfresco.rest.core.v0.BaseAPI

ACTIONS_API, contentService, NODE_PREFIX, NODE_REF_WORKSPACE_SPACES_STORE, RM_ACTIONS_API, RM_SITE_ID, SHARE_ACTION_API, UPDATE_METADATA_API

Constructor Summary

Constructors

Constructor	Description
RecordFoldersAPI()

Method Summary

Modifier and Type	Method	Description
org.apache.http.HttpResponse	closeRecordFolder(String user, String password, String recordFolder)	Close the record folder
org.apache.http.HttpResponse	postFolderAction(String user, String password, org.json.JSONObject requestParams, String recordFolder)
org.apache.http.HttpResponse	postRecordAction(String user, String password, org.json.JSONObject requestParams, String recordId)
org.apache.http.HttpResponse	reOpenRecordFolder(String user, String password, String recordFolder)

Methods inherited from class org.alfresco.rest.core.v0.BaseAPI

addPropertyToRequest, deleteItem, doDeleteRequest, doGetRequest, doPostJsonRequest, doPostRequest, doPutJsonRequest, doPutRequest, doSlingshotPostJsonRequest, facetedRequest, getFilePlanPath, getItemNodeRef, getNodeRefSpacesStore, getObjectByPath, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValuesByUniquePropertyValue

Methods inherited from class java.lang.Object

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

Constructor Details

RecordFoldersAPI

public RecordFoldersAPI()

Method Details

closeRecordFolder

public org.apache.http.HttpResponse closeRecordFolder(String user,
 String password,
 String recordFolder)

Close the record folder

Parameters:

user - the user closing the folder

password - the user's password

recordFolder - the record folder name

Returns:

The HTTP Response (or null if the response could not be understood).

postFolderAction

public org.apache.http.HttpResponse postFolderAction(String user,
 String password,
 org.json.JSONObject requestParams,
 String recordFolder)

postRecordAction

public org.apache.http.HttpResponse postRecordAction(String user,
 String password,
 org.json.JSONObject requestParams,
 String recordId)

reOpenRecordFolder

public org.apache.http.HttpResponse reOpenRecordFolder(String user,
 String password,
 String recordFolder)