Interface SAPInfoPackageGroupStep

    • Method Detail

      • getNum

        Long getNum()
        Get the value for Num. (Position of the InfoPackage in the group) 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.
      • getObjVersion

        String getObjVersion()
        Get the value for ObjVersion. (Object version.)
        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.
      • isCheckBefore

        boolean isCheckBefore()
        Get the value for CheckBefore. (Check whether request was successful)
        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.
      • getWait

        Long getWait()
        Get the value for Wait. (Waiting time in minutes until execution of next request) 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.
      • isActive

        boolean isActive()
        Get the value for Active. (Indicates whether the InfoPackage should be executed)
        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.
      • getLnr

        String getLnr()
        Get the value for Lnr. (Quote from SAP's field description: Not More Closely Defined Area, Possibly Used for Patchlevels)
        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.
      • setNum

        void setNum​(Long newNum)
        Set the value for Num. (Position of the InfoPackage in the group) This value is mandatory.
        Parameters:
        newNum - the new value for Num. 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.
      • setObjVersion

        void setObjVersion​(String newObjVersion)
        Set the value for ObjVersion. (Object version.) This value is optional.
        Parameters:
        newObjVersion - the new value for ObjVersion.
        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.
      • setCheckBefore

        void setCheckBefore​(boolean newCheckBefore)
        Set the value for CheckBefore. (Check whether request was successful)
        Parameters:
        newCheckBefore - the new value for CheckBefore.
        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.
      • setWait

        void setWait​(Long newWait)
        Set the value for Wait. (Waiting time in minutes until execution of next request) This value is mandatory.
        Parameters:
        newWait - the new value for Wait. 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.
      • setActive

        void setActive​(boolean newActive)
        Set the value for Active. (Indicates whether the InfoPackage should be executed)
        Parameters:
        newActive - the new value for Active.
        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.
      • setLnr

        void setLnr​(String newLnr)
        Set the value for Lnr. (Quote from SAP's field description: Not More Closely Defined Area, Possibly Used for Patchlevels) This value is optional.
        Parameters:
        newLnr - the new value for Lnr.
        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.
      • getSAPInfoPackageGroup

        SAPInfoPackageGroup getSAPInfoPackageGroup()
        Get the SAPInfoPackageGroup.
        Returns:
        SAPInfoPackageGroup
        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.