Interface ProcessMonitorItemDefinition

    • Method Detail

      • getDisplayOrder

        Long getDisplayOrder()
        Get the value for DisplayOrder. (The display order of the item) 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.
      • getType

        ProcessMonitorItemType getType()
        Get the value for Type. (The type of the Item) 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.
      • getInstanceExpression

        String getInstanceExpression()
        Get the value for InstanceExpression. (The optional expression for calculating the instance number of a referenced ProcessMonitor)
        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.
      • setDisplayOrder

        void setDisplayOrder​(Long newDisplayOrder)
        Set the value for DisplayOrder. (The display order of the item) This value is mandatory.
        Parameters:
        newDisplayOrder - the new value for DisplayOrder. 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.
      • setType

        void setType​(ProcessMonitorItemType newType)
        Set the value for Type. (The type of the Item) This value is mandatory.
        Parameters:
        newType - the new value for Type. 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.
      • setInstanceExpression

        void setInstanceExpression​(String newInstanceExpression)
        Set the value for InstanceExpression. (The optional expression for calculating the instance number of a referenced ProcessMonitor) This value is optional.
        Parameters:
        newInstanceExpression - the new value for InstanceExpression.
        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.
      • getProcessMonitorDefinition

        ProcessMonitorDefinition getProcessMonitorDefinition()
        Get the ProcessMonitorDefinition.
        Returns:
        ProcessMonitorDefinition
        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.
      • getSubProcessMonitorDefinition

        ProcessMonitorDefinition getSubProcessMonitorDefinition()
        Get the SubProcessMonitorDefinition.
        Returns:
        SubProcessMonitorDefinition
        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.
      • setSubProcessMonitorDefinition

        void setSubProcessMonitorDefinition​(ProcessMonitorDefinition newSubProcessMonitorDefinition)
        Set the value for SubProcessMonitorDefinition. This value is optional.
        Parameters:
        newSubProcessMonitorDefinition - is the object to set SubProcessMonitorDefinition to. The sub process monitor definition of this item