org.alfresco.rm.rest.api.records

Class RecordsEntityResource

java.lang.Object

org.alfresco.rm.rest.api.records.RecordsEntityResource

All Implemented Interfaces:

org.alfresco.rest.framework.resource.actions.interfaces.BinaryResourceAction.Read, org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.Delete, org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.ReadById<Record>, org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.Update<Record>, org.alfresco.rest.framework.resource.actions.interfaces.ResourceAction, org.springframework.beans.factory.InitializingBean

@EntityResource(name="records",
                title="Records")
public class RecordsEntityResource
extends Object
implements org.alfresco.rest.framework.resource.actions.interfaces.BinaryResourceAction.Read, org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.ReadById<Record>, org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.Delete, org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.Update<Record>, org.springframework.beans.factory.InitializingBean

An implementation of an Entity Resource for a record

Since:

2.6

Author:

Ana Bozianu, Tuna Aksoy

Constructor Summary

Constructors

Constructor and Description
RecordsEntityResource()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
void	delete(String recordId, org.alfresco.rest.framework.resource.parameters.Parameters parameters)
Record	fileRecord(String recordId, TargetContainer target, org.alfresco.rest.framework.resource.parameters.Parameters parameters, org.alfresco.rest.framework.webscripts.WithResponse withResponse)
Record	readById(String recordId, org.alfresco.rest.framework.resource.parameters.Parameters parameters)
org.alfresco.rest.framework.resource.content.BinaryResource	readProperty(String recordId, org.alfresco.rest.framework.resource.parameters.Parameters parameters) Download content
void	setApiUtils(FilePlanComponentsApiUtils apiUtils)
void	setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)
void	setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)
void	setNodesModelFactory(ApiNodesModelFactory nodesModelFactory)
void	setRecordService(RecordService recordService)
void	setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)
Record	update(String recordId, Record recordInfo, org.alfresco.rest.framework.resource.parameters.Parameters parameters)

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordsEntityResource

public RecordsEntityResource()

Method Detail

setNodesModelFactory

public void setNodesModelFactory(ApiNodesModelFactory nodesModelFactory)

setApiUtils

public void setApiUtils(FilePlanComponentsApiUtils apiUtils)

setRecordService

public void setRecordService(RecordService recordService)

setNodeService

public void setNodeService(org.alfresco.service.cmr.repository.NodeService nodeService)

setFileFolderService

public void setFileFolderService(org.alfresco.service.cmr.model.FileFolderService fileFolderService)

setTransactionService

public void setTransactionService(org.alfresco.service.transaction.TransactionService transactionService)

readProperty

public org.alfresco.rest.framework.resource.content.BinaryResource readProperty(String recordId,
                                                                                org.alfresco.rest.framework.resource.parameters.Parameters parameters)
                                                                         throws org.alfresco.rest.framework.core.exceptions.EntityNotFoundException

Download content

Specified by:

readProperty in interface org.alfresco.rest.framework.resource.actions.interfaces.BinaryResourceAction.Read

Parameters:

recordId - the id of the record to get the content from

parameters - Parameters

Returns:

binary content resource

Throws:

org.alfresco.rest.framework.core.exceptions.EntityNotFoundException

fileRecord

public Record fileRecord(String recordId,
                         TargetContainer target,
                         org.alfresco.rest.framework.resource.parameters.Parameters parameters,
                         org.alfresco.rest.framework.webscripts.WithResponse withResponse)

readById

public Record readById(String recordId,
                       org.alfresco.rest.framework.resource.parameters.Parameters parameters)

Specified by:

readById in interface org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.ReadById<Record>

update

public Record update(String recordId,
                     Record recordInfo,
                     org.alfresco.rest.framework.resource.parameters.Parameters parameters)

Specified by:

update in interface org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.Update<Record>

delete

public void delete(String recordId,
                   org.alfresco.rest.framework.resource.parameters.Parameters parameters)

Specified by:

delete in interface org.alfresco.rest.framework.resource.actions.interfaces.EntityResourceAction.Delete

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception