com.auth0.json.mgmt

Class Rule

java.lang.Object

com.auth0.json.mgmt.Rule

public class Rule
extends java.lang.Object

Class that represents an Auth0 Rule object. Related to the RulesEntity entity.

Constructor Summary

Constructors

Constructor and Description
Rule(java.lang.String name, java.lang.String script)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Getter for the rule's identifier.
java.lang.String	getName() Getter for the name of the rule
java.lang.Integer	getOrder() Getter for the rule's order in relation to other rules.
java.lang.String	getScript() Getter for the code to be executed when the rule runs.
java.lang.String	getStage() Getter for the rule's execution stage.
java.lang.Boolean	isEnabled() Whether the rule is enabled or not.
void	setEnabled(java.lang.Boolean enabled) Sets if the rule is enabled or not.
void	setName(java.lang.String name) Setter for the name of the rule.
void	setOrder(java.lang.Integer order) Setter for the rule's order in relation to other rules.
void	setScript(java.lang.String script) Setter for the code to be executed when the rule runs.

Methods inherited from class java.lang.Object

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

Constructor Detail

Rule

public Rule(java.lang.String name,
            java.lang.String script)

Method Detail

getName

public java.lang.String getName()

Getter for the name of the rule

Returns:

the name.

setName

public void setName(java.lang.String name)

Setter for the name of the rule.

Parameters:

name - the name to set.

getScript

public java.lang.String getScript()

Getter for the code to be executed when the rule runs.

Returns:

the script.

setScript

public void setScript(java.lang.String script)

Setter for the code to be executed when the rule runs.

Parameters:

script - the script to set.

getId

public java.lang.String getId()

Getter for the rule's identifier.

Returns:

the id.

isEnabled

public java.lang.Boolean isEnabled()

Whether the rule is enabled or not.

Returns:

true if the rule is enabled, false otherwise.

setEnabled

public void setEnabled(java.lang.Boolean enabled)

Sets if the rule is enabled or not.

Parameters:

enabled - whether the rule is enabled or not.

getOrder

public java.lang.Integer getOrder()

Getter for the rule's order in relation to other rules. A rule with a lower order than another rule executes first.

Returns:

the order.

setOrder

public void setOrder(java.lang.Integer order)

Setter for the rule's order in relation to other rules. A rule with a lower order than another rule executes first.

Parameters:

order - the order to set.

getStage

public java.lang.String getStage()

Getter for the rule's execution stage.

Returns:

the stage.