Package com.uc4.api.objects

Class SAPQueueManagerFilter

  • public class SAPQueueManagerFilter
extends java.lang.Object
    Filter for SAP RemoteTaskManager objects.

    • Constructor Detail

      • SAPQueueManagerFilter

        protected SAPQueueManagerFilter​(com.uc4.util.XMLDocument doc)

    • Method Detail

      • store

        protected void store​(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element request)
        Stores the content of this job under the request element.
        Parameters:
        doc - XML document
        request - the newly created elements are children of the request element

      • getUserName

        public java.lang.String getUserName()
        Returns:
        Name of the SAP User

      • setUserName

        public void setUserName​(java.lang.String userName)
        Parameters:
        userName - Name of the SAP User

      • getScheduledStartGreater

        public DateTime getScheduledStartGreater()
        Returns:
        Filter for the minimun Scheduled Start time

      • getScheduledStartLower

        public DateTime getScheduledStartLower()
        Returns:
        Filter for the maximum Scheduled Start time

      • setScheduledStartGreater

        public void setScheduledStartGreater​(DateTime scheduledStartGreater)
        Parameters:
        scheduledStartGreater - Filter for the minimun Scheduled Start time

      • setScheduledStartLower

        public void setScheduledStartLower​(DateTime scheduledStartLower)
        Parameters:
        scheduledStartLower - Filter for the maximum Scheduled Start time

      • getJobName

        public java.lang.String getJobName()
        Returns:
        Job name

      • setJobName

        public void setJobName​(java.lang.String jobName)
        Sets the Job name, Wildcard characters are allowed.
        Parameters:
        jobName - Job name

      • getJobCount

        public java.lang.String getJobCount()
        Returns:
        SAP Job ID

      • setJobCount

        public void setJobCount​(java.lang.String jobCount)
        Parameters:
        jobCount - SAP Job ID

      • getProcessChain

        public java.lang.String getProcessChain()
        Returns:
        Process Chain

      • setProcessChain

        public void setProcessChain​(java.lang.String processChain)
        Sets the Process Chain, Wildcard characters are allowed.
        Parameters:
        processChain - Process Chain value

      • getLongDescription

        public java.lang.String getLongDescription()
        Returns:
        Long Description

      • setLongDescription

        public void setLongDescription​(java.lang.String longDescription)
        Sets the Long Description, Wildcard characters are allowed.
        Parameters:
        longDescription - Long Description value

      • getStatus

        public int[] getStatus()
        Returns the Job status.
        Returns:
        Array of integers that contain the Job status values, see public constants in this class.

      • setStatus

        public void setStatus​(int[] status)
        Sets the Job status. For the values, see public constants in this class.
        Parameters:
        status - Status

      • isAvailableJobWithoutStartDate

        public boolean isAvailableJobWithoutStartDate()
        Returns:
        true if JobWithoutStartDate filter has been set.

      • isJobWithoutStartDate

        public boolean isJobWithoutStartDate()
        Returns:
        True if Jobs without start date should be added to the filter

      • setJobWithoutStartDate

        public void setJobWithoutStartDate​(java.lang.Boolean jobWithoutStartDate)
        Sets the filter configuration for Jobs without a start date.
        Parameters:
        jobWithoutStartDate - True if Jobs without start date should be added to the filter

      • isAvailableJobWithPredecessor

        public boolean isAvailableJobWithPredecessor()
        Returns:
        true if JobWithPredecessor filter has been set.

      • isJobWithPredecessor

        public boolean isJobWithPredecessor()
        Returns:
        True if Jobs without start date should be added to the filter

      • setJobWithPredecessor

        public void setJobWithPredecessor​(java.lang.Boolean jobWithPredecessor)
        Sets the configuration for Jobs with predecessors.
        Parameters:
        jobWithPredecessor - True if Jobs without start date should be added to the filter

      • getEventID

        public java.lang.String getEventID()
        Returns:
        Event ID

      • setEventID

        public void setEventID​(java.lang.String eventID)
        Sets the Event ID.
        Parameters:
        eventID - ID of the SAP Event

      • getEventParameter

        public java.lang.String getEventParameter()
        Returns:
        Event Parameter

      • setEventParameter

        public void setEventParameter​(java.lang.String eventParameter)
        Sets the parameter value of the SAP Event.
        Parameters:
        eventParameter - Event Parameter

      • getClient

        public java.lang.String getClient()
        Returns:
        SAP Client

      • setClient

        public void setClient​(java.lang.String client)
        Parameters:
        client - SAP Client

      • getJobGroup

        public java.lang.String getJobGroup()
        Returns:
        Name of the Job Group

      • setJobGroup

        public void setJobGroup​(java.lang.String jobGroup)
        Parameters:
        jobGroup - Name of the Job Group

      • setExternalJobChildrenOnly

        public void setExternalJobChildrenOnly​(java.lang.Boolean value)
        Parameters:
        value - External job children only

      • setNodeName

        public void setNodeName​(java.lang.String nodeName)
        Sets the SAP node name.
        Parameters:
        nodeName - the SAP node name.

      • getNodeName

        public java.lang.String getNodeName()
        Method to fetch the SAP node name.
        Returns:
        SAP node name.

      • setReturnCode

        public void setReturnCode​(java.lang.Integer returnCode)
        Sets the SAP return code.
        Parameters:
        returnCode - the SAP return code.

      • getReturnCode

        public java.lang.Integer getReturnCode()
        Method to fetch SAP return code.
        Returns:
        SAP return code.

      • isAvailableExternalJobChildrenOnly

        public boolean isAvailableExternalJobChildrenOnly()
        Returns:
        true if ExternalJobChildrenOnly filter has been set.

      • isExternalJobChildrenOnly

        public boolean isExternalJobChildrenOnly()
        Returns:
        External job children only

      • getTypeNumber

        public int getTypeNumber()
        Returns:
        type of filter