org.alfresco.rest.api.nodes

Class NodeChildrenRelation

java.lang.Object

org.alfresco.rest.api.nodes.NodeChildrenRelation

All Implemented Interfaces:

MultiPartRelationshipResourceAction.Create<Node>, RelationshipResourceAction.Create<Node>, RelationshipResourceAction.Read<Node>, ResourceAction, org.springframework.beans.factory.InitializingBean

@RelationshipResource(name="children",
                      entityResource=NodesEntityResource.class,
                      title="Folder children")
public class NodeChildrenRelation
extends Object
implements RelationshipResourceAction.Read<Node>, RelationshipResourceAction.Create<Node>, MultiPartRelationshipResourceAction.Create<Node>, org.springframework.beans.factory.InitializingBean

Node Children - list folder children - create folder &/or empty file - create (ie. upload) file with content

Author:

janv, Jamal Kaabi-Mofrad

Constructor Summary

Constructors

Constructor and Description
NodeChildrenRelation()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
Node	create(String parentFolderNodeId, org.springframework.extensions.webscripts.servlet.FormData formData, Parameters parameters, WithResponse withResponse)
List<Node>	create(String parentFolderNodeId, List<Node> nodeInfos, Parameters parameters) Create one or more nodes (folder or empty file) below parent folder.
CollectionWithPagingInfo<Node>	readAll(String parentFolderNodeId, Parameters parameters) List folder children - returns a filtered/sorted/paged list of nodes that are immediate children of the parent folder
void	setNodes(Nodes nodes)

Methods inherited from class java.lang.Object

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

Constructor Detail

NodeChildrenRelation

public NodeChildrenRelation()

Method Detail

setNodes

public void setNodes(Nodes nodes)

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

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

readAll

public CollectionWithPagingInfo<Node> readAll(String parentFolderNodeId,
                                              Parameters parameters)

List folder children - returns a filtered/sorted/paged list of nodes that are immediate children of the parent folder

Specified by:

readAll in interface RelationshipResourceAction.Read<Node>

Parameters:

parentFolderNodeId - String id of parent folder - will also accept well-known alias, eg. -root- or -my- or -shared- Optional query parameters: - include - fields - where - orderBy - skipCount - maxItems - ... etc Please refer to OpenAPI spec for more details ! If parentFolderNodeId does not exist, EntityNotFoundException (status 404). If parentFolderNodeId does not represent a folder, InvalidArgumentException (status 400).

parameters - - will never be null and will have the PAGING default values

create

public List<Node> create(String parentFolderNodeId,
                         List<Node> nodeInfos,
                         Parameters parameters)

Create one or more nodes (folder or empty file) below parent folder. Note: for parent folder nodeId, can also use well-known alias, eg. -root- or -my- or -shared- If parentFolderNodeId does not exist, EntityNotFoundException (status 404). If parentFolderNodeId does not represent a folder, InvalidArgumentException (status 400).

Specified by:

create in interface RelationshipResourceAction.Create<Node>

create

public Node create(String parentFolderNodeId,
                   org.springframework.extensions.webscripts.servlet.FormData formData,
                   Parameters parameters,
                   WithResponse withResponse)

Specified by:

create in interface MultiPartRelationshipResourceAction.Create<Node>