Package com.redwood.scheduler.api.connector.sap.rfc.scripting.xbp

Interface XbpJob

    • Method Detail

      • getJobname

        String getJobname()
        Get the name of the job
        Returns:
        job name

      • getJobcount

        String getJobcount()
        Get the id of the job aka jobcount
        Returns:
        job ID aka jobcount

      • getStatus

        com.redwood.scheduler.api.model.enumeration.SapBatchJobStatus getStatus()
        Get the status of the job
        Returns:
        status of the job, or null if the status of the job is not known

      • getJobgroup

        String getJobgroup()
        Get the group of the job
        Returns:
        job group

      • getJobclass

        String getJobclass()
        Get the class (A, B, C) of the job
        Returns:
        job class

      • getClient

        String getClient()
        Get the client number of the job
        Returns:
        job client

      • getEventId

        String getEventId()
        Get the batch event id
        Returns:
        event id

      • getEventParameter

        String getEventParameter()
        Get the batch event parameter
        Returns:
        event parameter

      • isPeriodic

        boolean isPeriodic()
        Check if this is a periodic job
        Returns:
        true if the job is periodic, false otherwise

      • getCreationTime

        DateTimeZone getCreationTime()
        Creation time and date of the job TBTCO fields: SDLDATE / SDLTIME
        Returns:
        creation time

      • getCreatorUser

        String getCreatorUser()
        Creation user of the job TBTCO field: SDLUNAME
        Returns:
        creation user

      • getScheduledStartTime

        DateTimeZone getScheduledStartTime()
        Scheduled start time and date of the job TBTCO fields: SDLSTRTDT / SDLSTRTTM
        Returns:
        scheduled start time

      • getStartTime

        DateTimeZone getStartTime()
        Start time and date of the job TBTCO fields: STRTDATE / STRTTIME
        Returns:
        start time

      • getEndTime

        DateTimeZone getEndTime()
        End time and date of the job TBTCO fields: ENDDATE / ENDTIME
        Returns:
        end time

      • getReleaseTime

        DateTimeZone getReleaseTime()
        Release time and date of the job TBTCO fields: RELDATE / RELTIME
        Returns:
        release time

      • getReleaseUser

        String getReleaseUser()
        Release user of the job TBTCO field: RELUNAME
        Returns:
        release user

      • getModificationTime

        DateTimeZone getModificationTime()
        Last modification time and date of the job TBTCO fields: LASTCHDATE / LASTCHTIME
        Returns:
        last modification time

      • getModifierUser

        String getModifierUser()
        User who has modified the job TBTCO field: LASTCHNAME
        Returns:
        modifier user

      • kill

        void kill()
        Kill the SAP job

      • getStep

        XbpJobStep getStep​(int stepNumber)
        Get the specified step of the job. Steps are counted from 1.
        Parameters:
        stepNumber - number of the step
        Returns:
        XbpJobStep of the job

      • getNumberOfSteps

        int getNumberOfSteps()
        Get the number of steps of this job
        Returns:
        number of steps

      • getParentJob

        XbpJob getParentJob()
        Get the parent of the job. Returns null if XBP 2.0 is not available, i.e. it is not required to explicitly check if XBP 2.0 is available before calling this method.
        Returns:
        XbpJob reference to the parent job, or nullif the job does not have a parent

      • getChildJobs

        Iterator<XbpJob> getChildJobs​(XbpJobSelectionOption option)
        Get the children of the job. Returns an empty Iterator if XBP 2.0 is not available, i.e. it is not required to explicitly check if XBP 2.0 is available before calling this method.
        Parameters:
        option - selection option
        Returns:
        Iterator with the XbpJob children of the job

      • confirmGenerally

        void confirmGenerally()
        Confirm this job generally

      • confirmSpecifically

        void confirmSpecifically()
        Confirm this job specifically