Package com.redwood.scheduler.api.model

Interface AlertEscalation

    • Method Detail

      • getAddress

        String getAddress()
        Get the value for Address. (The (optional) address to send this alert to)
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getDelayAmount

        Long getDelayAmount()
        Get the value for DelayAmount. (Number of 'delay time units' after the initiation of this channel to evaluate further channels.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getDelayUnits

        TimeUnit getDelayUnits()
        Get the value for DelayUnits. (Time units for 'delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getValidity

        Validity getValidity()
        Get the value for Validity. (Is this definition valid? That is, can this definition currently be used?) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setAddress

        void setAddress​(String newAddress)
        Set the value for Address. (The (optional) address to send this alert to) This value is optional.
        Parameters:
        newAddress - the new value for Address.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setDelayAmount

        void setDelayAmount​(Long newDelayAmount)
        Set the value for DelayAmount. (Number of 'delay time units' after the initiation of this channel to evaluate further channels.) This value is mandatory.
        Parameters:
        newDelayAmount - the new value for DelayAmount. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setDelayUnits

        void setDelayUnits​(TimeUnit newDelayUnits)
        Set the value for DelayUnits. (Time units for 'delay amount' - seconds, minutes, hours, days. May not be null, defaults to minutes) This value is mandatory.
        Parameters:
        newDelayUnits - the new value for DelayUnits. If this is null, then the object cannot be persisted.
        Throws:
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getDefaultAlertEscalation

        AlertEscalation getDefaultAlertEscalation()
        Get the DefaultAlertEscalation.
        Returns:
        DefaultAlertEscalation
        Throws:
        com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.
        com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

      • setDefaultAlertEscalation

        void setDefaultAlertEscalation​(AlertEscalation newDefaultAlertEscalation)
        Set the value for DefaultAlertEscalation. This value is optional.
        Parameters:
        newDefaultAlertEscalation - is the object to set DefaultAlertEscalation to. The default escalation channel for this alert escalation.

      • getAlertEscalationActionByType

        AlertEscalationAction getAlertEscalationActionByType​(AlertEscalationActionType type)
        Get the AlertEscalationAction by AlertEscalationActionType.
        Parameters:
        type -
        Returns:
        the AlertEscalationAction, or null if it could not be found

      • checkCreatePrivilege

        RequiredPermission checkCreatePrivilege()
        Check whether or not the create action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkViewPrivilege

        RequiredPermission checkViewPrivilege()
        Check whether or not the view action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkEditPrivilege

        RequiredPermission checkEditPrivilege()
        Check whether or not the edit action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

      • checkDeletePrivilege

        RequiredPermission checkDeletePrivilege()
        Check whether or not the delete action can be performed on this object.
        Returns:
        a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.