Interface SAPExternalCommand

    • Method Detail

      • getSAPLanguage

        String getSAPLanguage()
        Get the value for SAPLanguage. (SAP language.) 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.
      • getOsType

        String getOsType()
        Get the value for OsType. (OS type.) 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.
      • getProgram

        String getProgram()
        Get the value for Program. (Name of external program (possibly with access path)) 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.
      • getParameters

        String getParameters()
        Get the value for Parameters. (Parameters of the command.)
        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.
      • getAdditionalParameters

        String getAdditionalParameters()
        Get the value for AdditionalParameters. (Additional parameters allowed in logical command.)
        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.
      • getIsSapCommand

        String getIsSapCommand()
        Get the value for IsSapCommand. (Type of a logical command ('X' means provided by SAP).)
        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.
      • getSapPermition

        String getSapPermition()
        Get the value for SapPermition. (Execute permission for logical commands.)
        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.
      • getTraceOn

        String getTraceOn()
        Get the value for TraceOn. (Automatic trace for logical commands.)
        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.
      • getCheckAll

        String getCheckAll()
        Get the value for CheckAll. (Function module to check a logical command.)
        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.
      • setSAPLanguage

        void setSAPLanguage​(String newSAPLanguage)
        Set the value for SAPLanguage. (SAP language.) This value is mandatory.
        Parameters:
        newSAPLanguage - the new value for SAPLanguage. 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.
      • setOsType

        void setOsType​(String newOsType)
        Set the value for OsType. (OS type.) This value is mandatory.
        Parameters:
        newOsType - the new value for OsType. 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.
      • setProgram

        void setProgram​(String newProgram)
        Set the value for Program. (Name of external program (possibly with access path)) This value is mandatory.
        Parameters:
        newProgram - the new value for Program. 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.
      • setParameters

        void setParameters​(String newParameters)
        Set the value for Parameters. (Parameters of the command.) This value is optional.
        Parameters:
        newParameters - the new value for Parameters.
        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.
      • setAdditionalParameters

        void setAdditionalParameters​(String newAdditionalParameters)
        Set the value for AdditionalParameters. (Additional parameters allowed in logical command.) This value is optional.
        Parameters:
        newAdditionalParameters - the new value for AdditionalParameters.
        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.
      • setIsSapCommand

        void setIsSapCommand​(String newIsSapCommand)
        Set the value for IsSapCommand. (Type of a logical command ('X' means provided by SAP).) This value is optional.
        Parameters:
        newIsSapCommand - the new value for IsSapCommand.
        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.
      • setSapPermition

        void setSapPermition​(String newSapPermition)
        Set the value for SapPermition. (Execute permission for logical commands.) This value is optional.
        Parameters:
        newSapPermition - the new value for SapPermition.
        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.
      • setTraceOn

        void setTraceOn​(String newTraceOn)
        Set the value for TraceOn. (Automatic trace for logical commands.) This value is optional.
        Parameters:
        newTraceOn - the new value for TraceOn.
        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.
      • setCheckAll

        void setCheckAll​(String newCheckAll)
        Set the value for CheckAll. (Function module to check a logical command.) This value is optional.
        Parameters:
        newCheckAll - the new value for CheckAll.
        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.
      • 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.