Interface SAPXBPEventRule

    • Method Detail

      • getDescription

        String getDescription()
        Get the value for Description. (The description of this step)
        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.
      • getSAPEventId

        String getSAPEventId()
        Get the value for SAPEventId. (SAP event id mask.) 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.
      • getSAPEventParameter

        String getSAPEventParameter()
        Get the value for SAPEventParameter. (SAP event parameter mask.) 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.
      • isEnabled

        boolean isEnabled()
        Get the value for Enabled. (Whether this rule is currently enabled or not.)
        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.
      • setDescription

        void setDescription​(String newDescription)
        Set the value for Description. (The description of this step) This value is optional.
        Parameters:
        newDescription - the new value for Description.
        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.
      • setSAPEventId

        void setSAPEventId​(String newSAPEventId)
        Set the value for SAPEventId. (SAP event id mask.) This value is mandatory.
        Parameters:
        newSAPEventId - the new value for SAPEventId. 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.
      • setSAPEventParameter

        void setSAPEventParameter​(String newSAPEventParameter)
        Set the value for SAPEventParameter. (SAP event parameter mask.) This value is mandatory.
        Parameters:
        newSAPEventParameter - the new value for SAPEventParameter. 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.
      • setEnabled

        void setEnabled​(boolean newEnabled)
        Set the value for Enabled. (Whether this rule is currently enabled or not.)
        Parameters:
        newEnabled - the new value for Enabled.
        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.
      • getEventDefinition

        EventDefinition getEventDefinition()
        Get the EventDefinition.
        Returns:
        EventDefinition
        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.
      • getSAPSystem

        SAPSystem getSAPSystem()
        Get the SAPSystem.
        Returns:
        SAPSystem
        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.
      • setEventDefinition

        void setEventDefinition​(EventDefinition newEventDefinition)
        Set the value for EventDefinition. This value is mandatory.
        Parameters:
        newEventDefinition - is the object to set EventDefinition to. Which event should be triggered when an SAP event is triggered. If this is null, then the object cannot be persisted.