Package org.alfresco.rest.api

Interface Rules

All Known Implementing Classes:

RulesImpl

@Experimental
public interface Rules

Folder node rules API.

Method Summary

Modifier and Type	Method	Description
List<Rule>	createRules(String folderNodeId, String ruleSetId, List<Rule> rule)	Create 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 node
Rule	getRuleById(String folderNodeId, String ruleSetId, String ruleId)	Get rule for rule's ID and check associations with folder node and rule set node
CollectionWithPagingInfo<Rule>	getRules(String folderNodeId, String ruleSetId, Paging paging)	Get rules for node's and rule set's IDs

Method Detail

getRules

CollectionWithPagingInfo<Rule> getRules(String folderNodeId,
                                        String ruleSetId,
                                        Paging paging)

Get rules for node's and rule set's IDs

Parameters:

folderNodeId - - folder node ID

ruleSetId - - rule set ID

paging - - Paging information

Returns:

CollectionWithPagingInfo containing a list page of folder rules

getRuleById

Rule getRuleById(String folderNodeId,
                 String ruleSetId,
                 String ruleId)

Get rule for rule's ID and check associations with folder node and rule set node

Parameters:

folderNodeId - - folder node ID

ruleSetId - - rule set ID

ruleId - - rule ID

Returns:

Rule definition

createRules

List<Rule> createRules(String folderNodeId,
                       String ruleSetId,
                       List<Rule> rule)

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.

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.

deleteRuleById

void deleteRuleById(String folderNodeId,
                    String ruleSetId,
                    String ruleId)

Delete rule for rule's ID and check associations with folder node and rule set node

Parameters:

folderNodeId - - folder node ID

ruleSetId - - rule set ID

ruleId - - rule ID *