Package org.alfresco.rest.api.nodes

Class NodeRuleSetsRelation

java.lang.Object

org.alfresco.rest.api.nodes.NodeRuleSetsRelation

All Implemented Interfaces:

RelationshipResourceAction.Read<RuleSet>, RelationshipResourceAction.ReadById<RuleSet>, ResourceAction, org.springframework.beans.factory.InitializingBean

@Experimental
@RelationshipResource(name="rule-sets",
                      entityResource=NodesEntityResource.class,
                      title="Folder node rule sets")
public class NodeRuleSetsRelation
extends Object
implements RelationshipResourceAction.Read<RuleSet>, RelationshipResourceAction.ReadById<RuleSet>, org.springframework.beans.factory.InitializingBean

Folder node rule sets.

Constructor Summary

Constructors

Constructor	Description
NodeRuleSetsRelation()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
CollectionWithPagingInfo<RuleSet>	readAll(String folderNodeId, Parameters parameters)	List rule sets for given folder.
RuleSet	readById(String folderNodeId, String ruleSetId, Parameters parameters)	Get single folder rule for given node's, rule set's and rule's IDs.
void	setRuleSets(RuleSets ruleSets)

Methods inherited from class java.lang.Object

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

Constructor Details

NodeRuleSetsRelation

public NodeRuleSetsRelation()

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

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

Throws:

Exception

readAll

public CollectionWithPagingInfo<RuleSet> readAll(String folderNodeId,
 Parameters parameters)

List rule sets for given folder.

- GET /nodes/{folderNodeId}/rule-sets

Specified by:

readAll in interface RelationshipResourceAction.Read<RuleSet>

Parameters:

folderNodeId - The id of the folder node.

parameters - Contains paging information and information about which fields to include

Returns:

CollectionWithPagingInfo containing a page of rule sets

readById

public RuleSet readById(String folderNodeId,
 String ruleSetId,
 Parameters parameters)
                 throws RelationshipResourceNotFoundException

Get single folder rule for given node's, rule set's and rule's IDs.

- GET /nodes/{folderNodeId}/rule-sets/{ruleSetId}

Specified by:

readById in interface RelationshipResourceAction.ReadById<RuleSet>

Parameters:

folderNodeId - - entity resource context for this relationship

ruleSetId - - rule set node ID (associated with folder node)

parameters - Contains information about which fields to include

Returns:

RuleSet definition

Throws:

RelationshipResourceNotFoundException - in case resource was not found

setRuleSets

public void setRuleSets(RuleSets ruleSets)