Package org.alfresco.rest.api.nodes
Class NodeRulesRelation
java.lang.Object
org.alfresco.rest.api.nodes.NodeRulesRelation
- All Implemented Interfaces:
RelationshipResourceAction.Create<Rule>
,RelationshipResourceAction.Delete
,RelationshipResourceAction.Read<Rule>
,RelationshipResourceAction.ReadById<Rule>
,RelationshipResourceAction.Update<Rule>
,ResourceAction
,org.springframework.beans.factory.InitializingBean
@Experimental
@RelationshipResource(name="rules",
entityResource=NodeRuleSetsRelation.class,
title="Folder node rules")
public class NodeRulesRelation
extends Object
implements RelationshipResourceAction.Read<Rule>, RelationshipResourceAction.ReadById<Rule>, RelationshipResourceAction.Create<Rule>, RelationshipResourceAction.Update<Rule>, RelationshipResourceAction.Delete, org.springframework.beans.factory.InitializingBean
Folder node's rules.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
create
(String folderNodeId, List<Rule> ruleList, Parameters parameters) Create one or more rules inside a given folder and rule set.void
delete
(String folderNodeId, String ruleSetId, Parameters parameters) Delete single folder rule for given node's, rule set's and rule's IDs.readAll
(String folderNodeId, Parameters parameters) List folder rules for given folder node's and rule set's IDs as a page.readById
(String folderNodeId, String ruleSetId, Parameters parameters) Get single folder rule for given node's, rule set's and rule's IDs.void
update
(String folderNodeId, Rule rule, Parameters parameters) Update the specified folder rule.
-
Constructor Details
-
NodeRulesRelation
public NodeRulesRelation()
-
-
Method Details
-
afterPropertiesSet
- Specified by:
afterPropertiesSet
in interfaceorg.springframework.beans.factory.InitializingBean
- Throws:
Exception
-
readAll
List folder rules for given folder node's and rule set's IDs as a page. - GET /nodes/{folderNodeId}/rule-sets/{ruleSetId}/rules- Specified by:
readAll
in interfaceRelationshipResourceAction.Read<Rule>
- Parameters:
folderNodeId
- - entity resource context for this relationshipparameters
- - will never be null. Contains i.a. paging information and ruleSetId (relationshipId)- Returns:
CollectionWithPagingInfo
containing a page of folder rules
-
readById
public Rule 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}/rules/{ruleId}- Specified by:
readById
in interfaceRelationshipResourceAction.ReadById<Rule>
- Parameters:
folderNodeId
- - entity resource context for this relationshipruleSetId
- - rule set node ID (associated with folder node)parameters
- - will never be null. Contains i.a. ruleId (relationship2Id)- Returns:
Rule
definition- Throws:
RelationshipResourceNotFoundException
- in case resource was not found
-
create
Create one or more rules inside a given folder and rule set.POST /nodes/{folderNodeId}/rule-sets/{ruleSetId}/rules
- Specified by:
create
in interfaceRelationshipResourceAction.Create<Rule>
- Parameters:
folderNodeId
- The folder in which to create the rule.ruleList
- The list of rules to create.parameters
- List of parameters including the rule set id as the relationship.- Returns:
- The newly created rules.
-
update
Update the specified folder rule.PUT /nodes/{folderNodeId}/rule-sets/{ruleSetId}/rules/{ruleId}
- Specified by:
update
in interfaceRelationshipResourceAction.Update<Rule>
- Parameters:
folderNodeId
- The id of the folder containing the rule.rule
- The updated rule.parameters
- List of parameters including the rule set id and rule id.- Returns:
- The updated rule.
- Throws:
RelationshipResourceNotFoundException
- in case resource was not found
-
delete
Delete single folder rule for given node's, rule set's and rule's IDs. - DELETE /nodes/{folderNodeId}/rule-sets/{ruleSetId}/rules/{ruleId}- Specified by:
delete
in interfaceRelationshipResourceAction.Delete
- Parameters:
folderNodeId
- - entity resource context for this relationshipruleSetId
- - rule set node ID (associated with folder node)parameters
- - Should not be null. Should contain at least ruleId (relationship2Id)- Throws:
RelationshipResourceNotFoundException
- in case resource was not found
-
setRules
-