Package org.alfresco.rest.api

Interface RuleSets

All Known Implementing Classes:
RuleSetsImpl
@Experimental public interface RuleSets
Rule sets API.

  • Method Details

    • getRuleSets

      CollectionWithPagingInfo<RuleSet> getRuleSets(String folderNodeId, List<String> includes, Paging paging)
      Get rule sets for a folder.
      Parameters:
      folderNodeId - Folder node ID
      paging - Paging information
      includes - List of fields to include in the rule set
      Returns:
      CollectionWithPagingInfo containing a list page of rule sets

    • getRuleSetById

      RuleSet getRuleSetById(String folderNodeId, String ruleSetId, List<String> includes)
      Get the rule set with the given ID and check associations with the folder node.
      Parameters:
      folderNodeId - Folder node ID
      ruleSetId - Rule set ID
      includes - List of fields to include in the rule set
      Returns:
      RuleSet definition

    • updateRuleSet

      RuleSet updateRuleSet(String folderNodeId, RuleSet ruleSet, List<String> includes)
      Update a rule set - for example to reorder the rules within it.
      Parameters:
      folderNodeId - Folder node ID
      ruleSet - The updated rule set.
      includes - List of fields to include in the response.
      Returns:
      The updated rule set from the server.

    • linkToRuleSet

      RuleSetLink linkToRuleSet(String folderNodeId, String linkToNodeId)
      Link a rule set to a folder

    • unlinkRuleSet

      void unlinkRuleSet(String folderNodeId, String ruleSetId)
      Removes the link between a rule set and a folder