org.alfresco.rest.framework.resource.actions.interfaces

Interface BinaryResourceAction.Read

All Superinterfaces:

ResourceAction

All Known Implementing Classes:

NodesEntityResource, PeopleEntityResource, ProcessDefinitionsRestEntityResource, ProcessesRestEntityResource, QuickShareLinkEntityResource, TrashcanEntityResource

Enclosing interface:

BinaryResourceAction

public static interface BinaryResourceAction.Read
extends ResourceAction

HTTP GET - Retrieve a binary resource

Method Summary

Modifier and Type	Method and Description
BinaryResource	readProperty(String entityId, Parameters parameters) Retrieves a binary property by returning a BinaryResource object.

Method Detail

readProperty

BinaryResource readProperty(String entityId,
                            Parameters parameters)
                     throws EntityNotFoundException

Retrieves a binary property by returning a BinaryResource object. The specific property is specified in the Parameters object. See Parameters.hasBinaryProperty(String) or Parameters.getBinaryProperty()

Parameters:

entityId - unique id

parameters - Parameters

Returns:

BinaryResource - Either FileBinaryResource or NodeBinaryResource

Throws:

EntityNotFoundException