org.alfresco.rm.rest.api

Interface RMNodes

All Superinterfaces:

org.alfresco.rest.api.Nodes

Deprecated.

@Deprecated
public interface RMNodes
extends org.alfresco.rest.api.Nodes

RM Nodes API

Since:

2.6

Author:

Ana Bozianu

Field Summary

Fields

Modifier and Type	Field and Description
static String	PARAM_INCLUDE_HAS_RETENTION_SCHEDULE Deprecated.
static String	PARAM_INCLUDE_IS_CLOSED Deprecated.
static String	PARAM_INCLUDE_IS_COMPLETED Deprecated.
static String	PARAM_INCLUDE_TRANSFER_ACCESSION_INDICATOR Deprecated.
static String	PARAM_INCLUDE_TRANSFER_LOCATION Deprecated.
static String	PARAM_INCLUDE_TRANSFER_PDF_INDICATOR Deprecated.
static String	PATH_FILE_PLAN Deprecated.
static String	PATH_HOLDS Deprecated.
static String	PATH_TRANSFERS Deprecated.
static String	PATH_UNFILED Deprecated.

Fields inherited from interface org.alfresco.rest.api.Nodes

OP_CREATE, OP_DELETE, OP_UPDATE, OP_UPDATE_PERMISSIONS, PARAM_ASSOC_TYPE, PARAM_AUTO_RENAME, PARAM_CREATEBYUSER, PARAM_CREATEDAT, PARAM_INCLUDE_ALLOWABLEOPERATIONS, PARAM_INCLUDE_ASPECTNAMES, PARAM_INCLUDE_ASSOCIATION, PARAM_INCLUDE_ISLINK, PARAM_INCLUDE_ISLOCKED, PARAM_INCLUDE_PATH, PARAM_INCLUDE_PERMISSIONS, PARAM_INCLUDE_PROPERTIES, PARAM_INCLUDE_SUBTYPES, PARAM_ISFILE, PARAM_ISFOLDER, PARAM_ISPRIMARY, PARAM_MIMETYPE, PARAM_MODIFIEDAT, PARAM_MODIFIEDBYUSER, PARAM_NAME, PARAM_NODETYPE, PARAM_OVERWRITE, PARAM_PERMANENT, PARAM_RELATIVE_PATH, PARAM_SIZEINBYTES, PARAM_VERSION_COMMENT, PARAM_VERSION_MAJOR, PATH_MY, PATH_ROOT, PATH_SHARED

Method Summary

Modifier and Type	Method and Description
org.alfresco.service.namespace.QName	getFilePlanType() Deprecated. Helper method to obtain file plan type or null if the rm site does not exist.
org.alfresco.service.cmr.repository.NodeRef	getOrCreatePath(String parentFolderNodeId, String relativePath, org.alfresco.service.namespace.QName nodeTypeQName) Deprecated. Gets or creates the relative path starting from the provided parent folder.
void	validateNodeType(String filePlanComponentId, org.springframework.extensions.webscripts.servlet.FormData formData, org.alfresco.service.namespace.QName requestedTypeQName) Deprecated. Validates if the component with provided id and provided parameters from formData belongs to the current endpoint.
void	validateNodeType(String filePlanComponentId, org.alfresco.rest.api.model.Node filePlanComponentInfo, org.alfresco.rest.framework.resource.parameters.Parameters parameters, org.alfresco.service.namespace.QName requestedTypeQName) Deprecated. Validates if the component with provided id, relativePath from new created filePlanComponent and provided parameters belongs to the current endpoint.
void	validateNodeType(String filePlanComponentId, org.alfresco.rest.framework.resource.parameters.Parameters parameters, org.alfresco.service.namespace.QName requestedTypeQName) Deprecated. Validates if the component with provided id and provided parameters belongs to the current endpoint.
void	validateRecord(String filePlanComponentId) Deprecated. Validates if the filePlanComponent with provided id is a record.

Methods inherited from interface org.alfresco.rest.api.Nodes

addChildren, addCustomAspects, addTargets, createNode, createQName, deleteNode, getAssocType, getAssocType, getContent, getContent, getDocument, getFolder, getFolderOrDocument, getFolderOrDocument, getFolderOrDocumentFullInfo, getNode, isSubClass, listChildren, lock, mapFromNodeAspects, mapFromNodeProperties, mapToNodeAspects, mapToNodeProperties, moveOrCopyNode, nodeMatches, unlock, updateContent, updateCustomAspects, updateNode, upload, validateNode, validateNode, validateNode, validateOrLookupNode

Field Detail

PATH_FILE_PLAN

static final String PATH_FILE_PLAN

Deprecated.

See Also:

Constant Field Values

PATH_TRANSFERS

static final String PATH_TRANSFERS

Deprecated.

See Also:

Constant Field Values

PATH_UNFILED

static final String PATH_UNFILED

Deprecated.

See Also:

Constant Field Values

PATH_HOLDS

static final String PATH_HOLDS

Deprecated.

See Also:

Constant Field Values

PARAM_INCLUDE_HAS_RETENTION_SCHEDULE

static final String PARAM_INCLUDE_HAS_RETENTION_SCHEDULE

Deprecated.

See Also:

Constant Field Values

PARAM_INCLUDE_IS_CLOSED

static final String PARAM_INCLUDE_IS_CLOSED

Deprecated.

See Also:

Constant Field Values

PARAM_INCLUDE_IS_COMPLETED

static final String PARAM_INCLUDE_IS_COMPLETED

Deprecated.

See Also:

Constant Field Values

PARAM_INCLUDE_TRANSFER_PDF_INDICATOR

static final String PARAM_INCLUDE_TRANSFER_PDF_INDICATOR

Deprecated.

See Also:

Constant Field Values

PARAM_INCLUDE_TRANSFER_LOCATION

static final String PARAM_INCLUDE_TRANSFER_LOCATION

Deprecated.

See Also:

Constant Field Values

PARAM_INCLUDE_TRANSFER_ACCESSION_INDICATOR

static final String PARAM_INCLUDE_TRANSFER_ACCESSION_INDICATOR

Deprecated.

See Also:

Constant Field Values

Method Detail

getOrCreatePath

org.alfresco.service.cmr.repository.NodeRef getOrCreatePath(String parentFolderNodeId,
                                                            String relativePath,
                                                            org.alfresco.service.namespace.QName nodeTypeQName)

Deprecated.

Gets or creates the relative path starting from the provided parent folder. The method decides the type of the created elements considering the parent container's type and the type of the node to be created.

Parameters:

parentFolderNodeId - the parent folder to start from

relativePath - the relative path

nodeTypeQName - the type of the node to be created

Returns:

reference to the last element of the created path

validateNodeType

void validateNodeType(String filePlanComponentId,
                      org.alfresco.rest.framework.resource.parameters.Parameters parameters,
                      org.alfresco.service.namespace.QName requestedTypeQName)

Deprecated.

Validates if the component with provided id and provided parameters belongs to the current endpoint.

Parameters:

filePlanComponentId - - file plan component id to check

parameters - - provided parameters

requestedTypeQName - - the requested type that identifies the endpoint we are in

validateNodeType

void validateNodeType(String filePlanComponentId,
                      org.springframework.extensions.webscripts.servlet.FormData formData,
                      org.alfresco.service.namespace.QName requestedTypeQName)

Deprecated.

Validates if the component with provided id and provided parameters from formData belongs to the current endpoint.

Parameters:

filePlanComponentId - - file plan component id to check

formData - - provided formData

requestedTypeQName - - the requested type that identifies the endpoint we are in

validateNodeType

void validateNodeType(String filePlanComponentId,
                      org.alfresco.rest.api.model.Node filePlanComponentInfo,
                      org.alfresco.rest.framework.resource.parameters.Parameters parameters,
                      org.alfresco.service.namespace.QName requestedTypeQName)

Deprecated.

Validates if the component with provided id, relativePath from new created filePlanComponent and provided parameters belongs to the current endpoint.

Parameters:

filePlanComponentId - - file plan component id to check

filePlanComponentInfo - - new created file plan component info

parameters - - provided parameters

requestedTypeQName - - the requested type that identifies the endpoint we are in

validateRecord

void validateRecord(String filePlanComponentId)

Deprecated.

Validates if the filePlanComponent with provided id is a record.

Parameters:

filePlanComponentId -

getFilePlanType

org.alfresco.service.namespace.QName getFilePlanType()

Deprecated.

Helper method to obtain file plan type or null if the rm site does not exist.

Returns:

file plan type or null