com.smartsheet.api.models

Class AutomationRule

java.lang.Object

com.smartsheet.api.models.IdentifiableModel<T>

com.smartsheet.api.models.NamedModel<Long>

com.smartsheet.api.models.AutomationRule

public class AutomationRule
extends NamedModel<Long>

Constructor Summary

Constructors

Constructor and Description
AutomationRule()

Method Summary

Modifier and Type	Method and Description
AutomationAction	getAction() Gets the automation action for this rule.
Date	getCreatedAt() Gets a timestamp of when the rule was created.
User	getCreatedBy() Gets the User object for the author of this rule.
AutomationRuleDisabledReason	getDisabledReason() Gets a machine-readable reason a rule is disabled.
String	getDisabledReasonText() Gets descriptive text for why this rule is disabled.
Boolean	getEnabled() Gets flag indicating if rule is active
Date	getModifiedAt() Gets a timestamp for the last modification to this rule.
User	getModifiedBy() Gets the User who last modified this rule.
Boolean	getUserCanModify() Gets a flag indicating if the current user can modify this rule.
AutomationRule	setAction(AutomationAction action) Sets the automation action for this rule.
AutomationRule	setCreatedAt(Date createdAt) Sets a timestamp for when the rule was created.
AutomationRule	setCreatedBy(User createdBy) Sets the User object for the author of this rule.
AutomationRule	setDisabledReason(AutomationRuleDisabledReason disabledReason) Sets a machine-readable reason a rule is disabled.
AutomationRule	setDisabledReasonText(String disabledReasonText) Sets descriptive text for why this rule is disabled.
AutomationRule	setEnabled(Boolean enabled) Sets flag indicating if rule is active
AutomationRule	setModifiedAt(Date modifiedAt) Sets a timestamp for the last modification to this rule
AutomationRule	setModifiedBy(User modifiedBy) Sets the User who last modified this rule.
AutomationRule	setUserCanModify(Boolean userCanModify) Sets a flag indicating if the current user can modify this rule.

Methods inherited from class com.smartsheet.api.models.NamedModel

getName, setName

Methods inherited from class com.smartsheet.api.models.IdentifiableModel

equals, getId, hashCode, setId

Methods inherited from class java.lang.Object

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

Constructor Detail

AutomationRule

public AutomationRule()

Method Detail

getAction

public AutomationAction getAction()

Gets the automation action for this rule.

Returns:

the automation action

setAction

public AutomationRule setAction(AutomationAction action)

Sets the automation action for this rule.

Parameters:

action - the automation action

getCreatedAt

public Date getCreatedAt()

Gets a timestamp of when the rule was created.

Returns:

the timestamp

setCreatedAt

public AutomationRule setCreatedAt(Date createdAt)

Sets a timestamp for when the rule was created.

Parameters:

createdAt - the timestamp

getCreatedBy

public User getCreatedBy()

Gets the User object for the author of this rule.

Returns:

the User object

setCreatedBy

public AutomationRule setCreatedBy(User createdBy)

Sets the User object for the author of this rule.

Parameters:

createdBy - the User object

getDisabledReason

public AutomationRuleDisabledReason getDisabledReason()

Gets a machine-readable reason a rule is disabled.

Returns:

the reason

setDisabledReason

public AutomationRule setDisabledReason(AutomationRuleDisabledReason disabledReason)

Sets a machine-readable reason a rule is disabled.

Parameters:

disabledReason - the reason

getDisabledReasonText

public String getDisabledReasonText()

Gets descriptive text for why this rule is disabled.

Returns:

the reason

setDisabledReasonText

public AutomationRule setDisabledReasonText(String disabledReasonText)

Sets descriptive text for why this rule is disabled.

Parameters:

disabledReasonText - the reason

getEnabled

public Boolean getEnabled()

Gets flag indicating if rule is active

Returns:

the flag

setEnabled

public AutomationRule setEnabled(Boolean enabled)

Sets flag indicating if rule is active

Parameters:

enabled - the flag

getModifiedAt

public Date getModifiedAt()

Gets a timestamp for the last modification to this rule.

Returns:

the timestamp

setModifiedAt

public AutomationRule setModifiedAt(Date modifiedAt)

Sets a timestamp for the last modification to this rule

Parameters:

modifiedAt - the timestamp

getModifiedBy

public User getModifiedBy()

Gets the User who last modified this rule.

Returns:

the User

setModifiedBy

public AutomationRule setModifiedBy(User modifiedBy)

Sets the User who last modified this rule.

Parameters:

modifiedBy -

getUserCanModify

public Boolean getUserCanModify()

Gets a flag indicating if the current user can modify this rule.

Returns:

the flag

setUserCanModify

public AutomationRule setUserCanModify(Boolean userCanModify)

Sets a flag indicating if the current user can modify this rule.

Parameters:

userCanModify - the flag