Package com.redwood.scheduler.api.model

Interface Trigger

    • Method Detail

      • getTriggerPoint

        TriggerPoint getTriggerPoint()
        Get the value for TriggerPoint. (The point where the trigger is linked to.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isEnabled

        boolean isEnabled()
        Get the value for Enabled. (Whether the trigger is enabled or not.)
        Specified by:
        isEnabled in interface ActionEnableObject
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getLogLevel

        LogLevel getLogLevel()
        Get the value for LogLevel. (What is the Log Level when logging from the trigger.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getMaxLogSize

        Long getMaxLogSize()
        Get the value for MaxLogSize. (What is the maximum size of each log file, in MB.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getMaxBackupFiles

        Long getMaxBackupFiles()
        Get the value for MaxBackupFiles. (What is the maximum number of backup files to keep.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • isLogFileEnabled

        boolean isLogFileEnabled()
        Get the value for LogFileEnabled. (Whether the trigger's log file is enabled or not.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getExecutionOrder

        Long getExecutionOrder()
        Get the value for ExecutionOrder. (The order of execution of the triggers.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getSource

        String getSource()
        Get the value for Source. (The full source of the Trigger.)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getStubSource

        String getStubSource()
        Get the value for StubSource. (The source for the stub of the trigger.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.
        Returns:
        the field
        Throws:
        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:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setTriggerPoint

        void setTriggerPoint​(TriggerPoint newTriggerPoint)
        Set the value for TriggerPoint. (The point where the trigger is linked to.) This value is mandatory.
        Parameters:
        newTriggerPoint - the new value for TriggerPoint. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setEnabled

        void setEnabled​(boolean newEnabled)
        Set the value for Enabled. (Whether the trigger is enabled or not.)
        Specified by:
        setEnabled in interface ActionEnableObject
        Parameters:
        newEnabled - the new value for Enabled.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setLogLevel

        void setLogLevel​(LogLevel newLogLevel)
        Set the value for LogLevel. (What is the Log Level when logging from the trigger.) This value is mandatory.
        Parameters:
        newLogLevel - the new value for LogLevel. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setMaxLogSize

        void setMaxLogSize​(Long newMaxLogSize)
        Set the value for MaxLogSize. (What is the maximum size of each log file, in MB.) This value is mandatory.
        Parameters:
        newMaxLogSize - the new value for MaxLogSize. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setMaxBackupFiles

        void setMaxBackupFiles​(Long newMaxBackupFiles)
        Set the value for MaxBackupFiles. (What is the maximum number of backup files to keep.) This value is mandatory.
        Parameters:
        newMaxBackupFiles - the new value for MaxBackupFiles. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setLogFileEnabled

        void setLogFileEnabled​(boolean newLogFileEnabled)
        Set the value for LogFileEnabled. (Whether the trigger's log file is enabled or not.)
        Parameters:
        newLogFileEnabled - the new value for LogFileEnabled.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setExecutionOrder

        void setExecutionOrder​(Long newExecutionOrder)
        Set the value for ExecutionOrder. (The order of execution of the triggers.) This value is mandatory.
        Parameters:
        newExecutionOrder - the new value for ExecutionOrder. If this is null, then the object cannot be persisted.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setSource

        void setSource​(String newSource)
        Set the value for Source. (The full source of the Trigger.) This value is optional.
        Parameters:
        newSource - the new value for Source.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setLibrary

        void setLibrary​(Library newLibrary)
        Set the value for Library. This value is mandatory.
        Parameters:
        newLibrary - is the object to set Library to. The library that the Trigger depends upon. If this is null, then the object cannot be persisted.

      • setActionSubject

        void setActionSubject​(Subject newActionSubject)
        Set the value for ActionSubject. This value is optional.
        Parameters:
        newActionSubject - is the object to set ActionSubject to. Who does this action execute as?

      • 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.