Package org.alfresco.rest.api.rules

Class NodeRulesRelation

java.lang.Object

org.alfresco.rest.api.rules.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

Constructor	Description
NodeRulesRelation()

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
List<Rule>	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.
CollectionWithPagingInfo<Rule>	readAll(String folderNodeId, Parameters parameters)	List folder rules for given folder node's and rule set's IDs as a page.
Rule	readById(String folderNodeId, String ruleSetId, Parameters parameters)	Get single folder rule for given node's, rule set's and rule's IDs.
void	setRules(Rules rules)
Rule	update(String folderNodeId, Rule rule, Parameters parameters)	Update the specified folder rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NodeRulesRelation

public NodeRulesRelation()

Method Details

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

readAll

public CollectionWithPagingInfo<Rule> readAll(String folderNodeId,
 Parameters parameters)

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 interface RelationshipResourceAction.Read<Rule>

Parameters:

folderNodeId - - entity resource context for this relationship

parameters - - 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 interface RelationshipResourceAction.ReadById<Rule>

Parameters:

folderNodeId - - entity resource context for this relationship

ruleSetId - - 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

public List<Rule> create(String folderNodeId,
 List<Rule> ruleList,
 Parameters parameters)

Create one or more rules inside a given folder and rule set.

POST /nodes/{folderNodeId}/rule-sets/{ruleSetId}/rules

Specified by:

create in interface RelationshipResourceAction.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

public Rule update(String folderNodeId,
 Rule rule,
 Parameters parameters)

Update the specified folder rule.

PUT /nodes/{folderNodeId}/rule-sets/{ruleSetId}/rules/{ruleId}

Specified by:

update in interface RelationshipResourceAction.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

public void delete(String folderNodeId,
 String ruleSetId,
 Parameters parameters)

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 interface RelationshipResourceAction.Delete

Parameters:

folderNodeId - - entity resource context for this relationship

ruleSetId - - 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

public void setRules(Rules rules)