Package org.alfresco.rest.api
Interface Rules
- All Known Implementing Classes:
RulesImpl
Folder node rules API.
-
Method Summary
Modifier and TypeMethodDescriptionCreate new rules (and potentially a rule set if "_default_" is supplied).void
deleteRuleById
(String folderNodeId, String ruleSetId, String ruleId) Delete rule for rule's ID and check associations with folder node and rule set nodeGet rule for rule's ID and check associations with folder node and rule set nodeGet rules for node's and rule set's IDsupdateRuleById
(String folderNodeId, String ruleSetId, String ruleId, Rule rule, List<String> includes) Update a rule.
-
Method Details
-
getRules
CollectionWithPagingInfo<Rule> getRules(String folderNodeId, String ruleSetId, List<String> includes, Paging paging) Get rules for node's and rule set's IDs- Parameters:
folderNodeId
- - folder node IDruleSetId
- - rule set IDincludes
- - The list of optional fields to include in the response.paging
- -Paging
information- Returns:
CollectionWithPagingInfo
containing a list page of folder rules
-
getRuleById
Get rule for rule's ID and check associations with folder node and rule set node- Parameters:
folderNodeId
- - folder node IDruleSetId
- - rule set IDruleId
- - rule IDincludes
- - The list of optional fields to include in the response.- Returns:
Rule
definition
-
createRules
List<Rule> createRules(String folderNodeId, String ruleSetId, List<Rule> rule, List<String> includes) Create new rules (and potentially a rule set if "_default_" is supplied).- Parameters:
folderNodeId
- The node id of a folder.ruleSetId
- The id of a rule set (or "_default_" to use/create the default rule set for the folder).rule
- The definition of the rule.includes
- The list of optional fields to include in the response.- Returns:
- The newly created rules.
- Throws:
InvalidArgumentException
- If the nodes are not the expected types, or the rule set does not correspond to the folder.RuleServiceException
- If the folder is already linked to another rule set.
-
updateRuleById
Rule updateRuleById(String folderNodeId, String ruleSetId, String ruleId, Rule rule, List<String> includes) Update a rule.- Parameters:
folderNodeId
- The id of a folder.ruleSetId
- The id of a rule set within the folder (or "_default_" to use the default rule set for the folder).ruleId
- The rule id.rule
- The new version of the rule.includes
- The list of optional fields to include in the response.- Returns:
- The newly updated rule.
-
deleteRuleById
Delete rule for rule's ID and check associations with folder node and rule set node- Parameters:
folderNodeId
- - folder node IDruleSetId
- - rule set IDruleId
- - rule ID *
-