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>
,RelationshipResourceAction.Update<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>, RelationshipResourceAction.Update<RuleSet>, org.springframework.beans.factory.InitializingBean
Folder node rule sets.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
readAll
(String folderNodeId, Parameters parameters) List rule sets for given folder.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) update
(String folderNodeId, RuleSet ruleSet, Parameters parameters) Update a rule set, in particular this is useful for reordering rules in a rule set.
-
Constructor Details
-
NodeRuleSetsRelation
public NodeRuleSetsRelation()
-
-
Method Details
-
afterPropertiesSet
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
Exception
-
readAll
List rule sets for given folder.- GET /nodes/{folderNodeId}/rule-sets
- Specified by:
readAll
in interfaceRelationshipResourceAction.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 interfaceRelationshipResourceAction.ReadById<RuleSet>
- Parameters:
folderNodeId
- - entity resource context for this relationshipruleSetId
- - 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
-
update
Update a rule set, in particular this is useful for reordering rules in a rule set.- PUT /nodes/{folderNodeId}/rule-sets/{ruleSetId}
- Specified by:
update
in interfaceRelationshipResourceAction.Update<RuleSet>
- Parameters:
folderNodeId
- The id for the folder.ruleSet
- The updated rule set.parameters
- Contains information about which fields to include in the response.- Returns:
- The updated rule set.
-