Package com.uc4.api

Class TaskFilter

  • public class TaskFilter
extends ObjectTypeFilter
    This class represents a filter for the activity list.

    • Field Detail

      • ANY_ACTIVE

        public static final java.lang.String ANY_ACTIVE
        Job is running. ANY_ACTIVE combines all Return Codes between 1300 and 1599.
        See Also:
        Constant Field Values

      • ANY_WAITING

        public static final java.lang.String ANY_WAITING
        Job is waiting. ANY_WAITING combines all Return Codes between 1600 and 1799.
        See Also:
        Constant Field Values

      • ANY_ABEND

        public static final java.lang.String ANY_ABEND
        Job disrupted. ANY_ABEND combines all Return Codes between 1800 and 1899.
        See Also:
        Constant Field Values

      • ANY_OK

        public static final java.lang.String ANY_OK
        Job ended normally. ANY_OK combines all Return Codes between 1900 and 1999.
        See Also:
        Constant Field Values

      • ANY_BLOCKING

        public static final java.lang.String ANY_BLOCKING
        Blocking tasks. ANY_BLOCKING combines all Return Codes between 1560 and 1564.
        See Also:
        Constant Field Values

    • Constructor Detail

      • TaskFilter

        public TaskFilter()
        Constructs a new TaskFilter object.

    • Method Detail

      • isExcludeObjectName

        public boolean isExcludeObjectName()
        Returns:
        true if the object name pattern is excluded from the selection.

      • isExcludePeriodDescription

        public boolean isExcludePeriodDescription()
        Returns:
        true if the period description pattern is excluded from the selection.

      • addQueueFilter

        public void addQueueFilter​(UC4ObjectName queue)
        Adds a new item to the filter for Queues. If called in client zero, this method does not have an effect, use addQueueFilter(UC4ObjectName queue, int client) instead.
        Parameters:
        queue - Name of the Queue Object

      • addQueueFilter

        public void addQueueFilter​(UC4ObjectName queue,
                           int client)
        Adds a certain Queue and a client to the filter for Queues. This method should be used if connected with client 0. If all queues from a certain client should be shown pass null for the parameter queue.
        Parameters:
        queue - Name of the Queue Object or null
        client - UC4 Client

      • getQueueObject

        public java.lang.String getQueueObject​(int n)
        Parameters:
        n - the index of the queue object in the filter
        Returns:
        Name of the Queue object if a filter for a Queue has been set or null if not set.

      • getQueueClient

        public int getQueueClient​(int n)
        If in client zero, its possible to set a filter for a Queue in a certain client. The client can be set using the method setQueueFilter(UC4ObjectName queue, int client) If not set the return value is -1.
        Parameters:
        n - the index of the queue object in the filter
        Returns:
        Client

      • getQueueObject

        public java.lang.String getQueueObject()
        Returns:
        Name of the Queue object if a filter for a Queue has been set or null if not set.

      • getQueueClient

        public int getQueueClient()
        If in client zero, its possible to set a filter for a Queue in a certain client. The client can be set using the method setQueueFilter(UC4ObjectName queue, int client) If not set the return value is -1.
        Returns:
        Client

      • getQueueObjectCount

        public int getQueueObjectCount()
        Returns:
        number of the Queue objects in the filter.

      • getQueueClientList

        public java.util.List<java.lang.Integer> getQueueClientList()
        Returns:
        queueClientList the list of all clients for the QueueList

      • getQueueList

        public java.util.List<java.lang.String> getQueueList()
        Returns:
        queueList the list of all queues to filter

      • setExcludeObjectName

        public void setExcludeObjectName​(boolean excludeObjectName)
        If excludeObjectName is set to true the Object is excluded from the selection.
        Parameters:
        excludeObjectName - Boolean value to exclude or include the Object name in the selection

      • setExcludePeriodDescription

        public void setExcludePeriodDescription​(boolean excludePeriodDescription)
        If excludePeriodDescription is set to true objects with the given period description are excluded from the selection.
        Parameters:
        excludePeriodDescription - Boolean value to exclude or include the period description in the selection

      • getHostAttrTypes

        public java.util.Set<java.lang.String> getHostAttrTypes()
        Gets the host attribute types.
        Returns:
        the host attr types

      • getParentRunID

        public int getParentRunID()
        Returns the filter for a parent RunID.
        Returns:
        Parent RunID or zero if this filter is not set

      • setParentRunID

        public void setParentRunID​(int parentRunID)
        Sets a filter for the parent RunID. Use zero to clear the filter.
        Parameters:
        parentRunID - Parent RunID or zero to disable the filter

      • getTopRunID

        public int getTopRunID()
        Returns the filter for a top RunID.
        Returns:
        Top RunID or zero if this filter is not set

      • setTopRunID

        public void setTopRunID​(int topRunID)
        Sets a filter for the top RunID. Use zero to clear the filter.
        Parameters:
        topRunID - Top RunID or zero to disable the filter

      • isExcludeUser

        public boolean isExcludeUser()
        Returns:
        true if the user name pattern is excluded from the selection.

      • setExcludeUser

        public void setExcludeUser​(boolean excludeUser)
        If excludeUser is set to true the user is excluded from the selection.
        Parameters:
        excludeUser - Boolean value to exclude or include the user in the selection

      • isExcludeHost

        public boolean isExcludeHost()
        Returns:
        true if the host name is excluded from the selection.

      • setExcludeHost

        public void setExcludeHost​(boolean excludeHost)
        If excludeHost is set to true the HOST is excluded from the selection.
        Parameters:
        excludeHost - Boolean value to exclude or include the HOST in the selection

      • isExcludeArchiveKey1

        public boolean isExcludeArchiveKey1()
        Returns:
        true if the Archive Key 1 is excluded from the selection.

      • setExcludeArchiveKey1

        public void setExcludeArchiveKey1​(boolean excludeArchiveKey1)
        If excludeArchiveKey1 is set to true the Archive Key 1 is excluded from the selection.
        Parameters:
        excludeArchiveKey1 - Boolean value to exclude or include the Archive Key 1 in the selection

      • isExcludeArchiveKey2

        public boolean isExcludeArchiveKey2()
        Returns:
        true if the Archive Key 2 is excluded from the selection.

      • setExcludeArchiveKey2

        public void setExcludeArchiveKey2​(boolean excludeArchiveKey2)
        If excludeArchiveKey2 is set to true the Archive Key 2 is excluded from the selection.
        Parameters:
        excludeArchiveKey2 - Boolean value to exclude or include the Archive Key 2 in the selection

      • getArchiveKey1

        public java.lang.String getArchiveKey1()
        Returns the current filter for the first archive key.
        Returns:
        first archive key

      • getArchiveKey2

        public java.lang.String getArchiveKey2()
        Returns the current filter for the second archive key.
        Returns:
        second archive key

      • getHost

        public java.lang.String getHost()
        Returns the selected hostname. The wildcard character * matches all hosts.
        Returns:
        host filter

      • getObjectName

        public java.lang.String getObjectName()
        Returns the filter for the object name. The wildcard character * can be used to select all object names.
        Returns:
        object name selection

      • getPeriodDescription

        public java.lang.String getPeriodDescription()
        Returns the filter for the period description. The wildcard character * can be used to select all object names.
        Returns:
        object name selection

      • getStatus

        public java.lang.String getStatus()
        Returns the selected status.
        Returns:
        status selection

      • getMessageNumber

        public java.lang.String getMessageNumber()
        Returns the remote status message number filter.
        Returns:
        the message number selection

      • getMessageInsert

        public java.lang.String getMessageInsert()
        Returns the remote status message insert filter.
        Returns:
        the message insert selection

      • getUser

        public java.lang.String getUser()
        Returns the selected user. The wildcard character * matches all users.
        Returns:
        user selection

      • isArchiveKeyAndRelation

        public boolean isArchiveKeyAndRelation()
        Returns if tasks should be returned where both archive keys match.
        Returns:
        archive key and relation

      • setObjectName

        public void setObjectName​(java.lang.String filter)
        Sets the filter for the object name. With the default entry "*", all objects are listed. Use the wild card characters "*" and "?" to set a filter. "*" stands for any number of characters, "?" for exactly one character.
        Parameters:
        filter - Object name filter

      • setPeriodDescription

        public void setPeriodDescription​(java.lang.String filter)
        Sets the filter for the period description. With the default entry "*", all objects are listed. Use the wild card characters "*" and "?" to set a filter. "*" stands for any number of characters, "?" for exactly one character.
        Parameters:
        filter - Object name filter

      • setQueueFilter

        public void setQueueFilter​(UC4ObjectName queue)
        Sets a filter for Queues. If called in client zero, this method does not have an effect, use setQueueFilter(UC4ObjectName queue, int client) instead.
        Parameters:
        queue - Name of the Queue Object

      • setQueueFilter

        public void setQueueFilter​(UC4ObjectName queue,
                           int client)
        Sets a filter for a certain Queue and a client. This method should be used if connected with client 0. If all queues from a certain client should be shown pass null for the parameter queue.
        Parameters:
        queue - Name of the Queue Object or null
        client - UC4 Client

      • setArchiveKey1

        public void setArchiveKey1​(java.lang.String key1)
        Sets the selection for the first archive key.
        Parameters:
        key1 - first archive key

      • setArchiveKey2

        public void setArchiveKey2​(java.lang.String key2)
        Sets the selection for the second archive key.
        Parameters:
        key2 - second archive key

      • setArchiveKeyAndRelation

        public void setArchiveKeyAndRelation​(boolean and)
        Sets the relation for archive keys. If and is true only tasks where both archive keys match the selection are returned.
        Parameters:
        and - true for AND-Relation

      • setHost

        public void setHost​(java.lang.String host)
        Sets the filter for the host name. Specify the name of a host or set a filter if you want to select more than one host. ("*") is set by default, which returns the tasks of all active hosts.
        Parameters:
        host - String containing the pattern of a host

      • setStatus

        public void setStatus​(java.lang.String statusText)
        Sets status of selected tasks.

        statusText contains a list of comma separated return codes. Example: "1850,1851"
        Ranges can also be used: 1800-1899 selects all tasks with return codes between 1800 and 1899. In addition there are contants to filter all active tasks (ANY_ACTIVE), waiting tasks (ANY_WAITING), abended tasks (ANY_ABEND) and ended tasks (ANY_OK)

        Parameters:
        statusText - Status

      • setMessageNumber

        public void setMessageNumber​(java.lang.String messageNumber)
        Sets the filter for the remote status message number.
        Parameters:
        messageNumber - remote status message number

      • setMessageNumber

        public void setMessageNumber​(int messageNumber)
        Sets the filter for the remote status message number.
        Parameters:
        messageNumber - remote status message number

      • setMessageInsert

        public void setMessageInsert​(java.lang.String messageInsert)
        Sets the filter for the remote status message insert. The wildcard character * matches all message inserts.
        Parameters:
        messageInsert - remote status message insert

      • setUser

        public void setUser​(java.lang.String user)
        Sets the filter for the user name. The wildcard character * matches all users.
        Parameters:
        user - User

      • selectAllPlatforms

        public void selectAllPlatforms()
        Select all platforms.

      • unselectAllPlatforms

        public void unselectAllPlatforms()
        Unselect all platforms.

      • isPlatformBS2000

        public boolean isPlatformBS2000()
        Returns true if BS2000 Jobs are selected.
        Returns:
        BS2000 Job selection

      • isPlatformCIT

        public boolean isPlatformCIT()
        Returns true if Rapid Automation Jobs are selected.
        Returns:
        Rapid Automation Job selection

      • isPlatformGCOS8

        public boolean isPlatformGCOS8()
        Returns true if GCOS8 Jobs are selected.
        Returns:
        GCOS8 Job selection

      • isPlatformJMX

        public boolean isPlatformJMX()
        Returns true if JMX Jobs are selected.
        Returns:
        JMX Job selection

      • isPlatformMAIL

        public boolean isPlatformMAIL()
        Returns true if MAIL Jobs are selected.
        Returns:
        MAIL Job selection

      • isPlatformMPE

        public boolean isPlatformMPE()
        Returns true if MPE Jobs are selected.
        Returns:
        MPE Job selection

      • isPlatformMVS

        public boolean isPlatformMVS()
        Returns true if MVS Jobs are selected.
        Returns:
        MVS Job selection

      • isPlatformNSK

        public boolean isPlatformNSK()
        Returns true if NSK Jobs are selected.
        Returns:
        NSK Job selection

      • isPlatformOA

        public boolean isPlatformOA()
        Returns true if OA Jobs are selected.
        Returns:
        OA Job selection

      • isPlatformOS400

        public boolean isPlatformOS400()
        Returns true if OS400 Jobs are selected.
        Returns:
        OS400 Job selection

      • isPlatformPS

        public boolean isPlatformPS()
        Returns true if PS Jobs are selected.
        Returns:
        PS Job selection

      • isPlatformR3

        public boolean isPlatformR3()
        Returns true if SAP Jobs are selected.
        Returns:
        SAP Job selection

      • isPlatformSiebel

        public boolean isPlatformSiebel()
        Returns true if Siebel Jobs are selected.
        Returns:
        Siebel Job selection

      • isPlatformSQL

        public boolean isPlatformSQL()
        Returns true if SQL Jobs are selected.
        Returns:
        SQL Job selection

      • isPlatformUNIX

        public boolean isPlatformUNIX()
        Returns true if UNIX Jobs are selected.
        Returns:
        UNIX Job selection

      • isPlatformVMS

        public boolean isPlatformVMS()
        Returns true if VMS Jobs are selected.
        Returns:
        VMS Job selection

      • isPlatformWindows

        public boolean isPlatformWindows()
        Returns true if Windows Jobs are selected.
        Returns:
        Windows Job selection

      • setPlatformPS

        public void setPlatformPS​(boolean platformPS)
        Select PS Jobs if the parameter platformPS is true.
        Parameters:
        platformPS - PS Job selection

      • setPlatformMPE

        public void setPlatformMPE​(boolean platformMPE)
        Select MPE Jobs if the parameter platformMPE is true.
        Parameters:
        platformMPE - MPE Job selection

      • setPlatformNSK

        public void setPlatformNSK​(boolean platformNSK)
        Select NSK Jobs if the parameter platformNSK is true.
        Parameters:
        platformNSK - NSK Job selection

      • setPlatformMVS

        public void setPlatformMVS​(boolean platformMVS)
        Select VMS Jobs if the parameter platformMVS is true.
        Parameters:
        platformMVS - VMS Job selection

      • setPlatformJMX

        public void setPlatformJMX​(boolean platformJMX)
        Select JMX Jobs if the parameter platformJMX is true.
        Parameters:
        platformJMX - JMX Job selection

      • setPlatformMAIL

        public void setPlatformMAIL​(boolean platformMAIL)
        Select MAIL Jobs if the parameter platformMAIL is true.
        Parameters:
        platformMAIL - MAIL Job selection

      • setPlatformBS2000

        public void setPlatformBS2000​(boolean platformBS2000)
        Select BS2000 Jobs if the parameter platformBS2000 is true.
        Parameters:
        platformBS2000 - BS2000 Jobs selection

      • setPlatformCIT

        public void setPlatformCIT​(boolean platformCIT)
        Select Rapid Automation Jobs if the parameter platformCIT is true.
        Parameters:
        platformCIT - Rapid Automation Job selection

      • setPlatformGCOS8

        public void setPlatformGCOS8​(boolean platformGCOS8)
        Select GCOS8 Jobs if the parameter platformGCOS8 is true.
        Parameters:
        platformGCOS8 - GCOS8 Job selection

      • setPlatformOA

        public void setPlatformOA​(boolean platformOA)
        Select OA Jobs if the parameter platformOA is true.
        Parameters:
        platformOA - OA Job selection

      • setPlatformOS400

        public void setPlatformOS400​(boolean platformOS400)
        Select OS400 Jobs if the parameter platformOS400 is true.
        Parameters:
        platformOS400 - OS400 Job selection

      • setPlatformR3

        public void setPlatformR3​(boolean platformR3)
        Select SAP Jobs if the parameter platformR3 is true.
        Parameters:
        platformR3 - SAP Job selection

      • setPlatformSiebel

        public void setPlatformSiebel​(boolean platformSiebel)
        Select Siebel Jobs if the parameter platformSiebel is true.
        Parameters:
        platformSiebel - Siebel Job selection

      • setPlatformUNIX

        public void setPlatformUNIX​(boolean platformUNIX)
        Select UNIX Jobs if the parameter platformUNIX is true.
        Parameters:
        platformUNIX - UNIX Job selection

      • setPlatformVMS

        public void setPlatformVMS​(boolean platformVMS)
        Select VMS Jobs if the parameter platformVMS is true.
        Parameters:
        platformVMS - VMS Job selection

      • setPlatformSQL

        public void setPlatformSQL​(boolean platformSQL)
        Select SQL Jobs if the parameter platformSQL is true.
        Parameters:
        platformSQL - SQL Job selection

      • setPlatformWindows

        public void setPlatformWindows​(boolean platformWindows)
        Select Windows Jobs if the parameter platformWindows is true.
        Parameters:
        platformWindows - Windows Job selection

      • addCustomAttributeFilter

        public void addCustomAttributeFilter​(CustomAttributeFilter customAttrFilter)
        Adds a CustomAttributeFilter.
        Parameters:
        customAttrFilter - CustomAttributeFilter

      • removeAllCustomAttributeFilter

        public void removeAllCustomAttributeFilter()
        Removes all CustomAttributeFilter.

      • removeCustomAttributeFilter

        public void removeCustomAttributeFilter​(CustomAttributeFilter customAttrFilter)
        Removes a specific CustomAttributeFilter.
        Parameters:
        customAttrFilter - CustomAttributeFilter to remove

      • customAttributeFilterIterator

        public java.util.Iterator<CustomAttributeFilter> customAttributeFilterIterator()
        Returns an Iterator over all CustomAttributeFilter.
        Returns:
        Iterator over all CustomAttributeFilter

      • setTimeFrame

        public void setTimeFrame​(TaskFilter.TimeFrame timeFrame)
        Sets the Activation Time Frame.
        Parameters:
        timeFrame - Time Frame

      • getTimeFrame

        public TaskFilter.TimeFrame getTimeFrame()
        Returns the selected Time Frame.
        Returns:
        TimeFrame

      • setTimestampFrom

        public void setTimestampFrom​(DateTime timestampFrom)
        Sets the From timestamp for the Activation.
        Parameters:
        timestampFrom - DateTime

      • getTimestampFrom

        public DateTime getTimestampFrom()
        Returns the From timestamp for the Activation.
        Returns:
        From timestamp

      • setTimestampTo

        public void setTimestampTo​(DateTime timestampTo)
        Sets the To timestamp for the Activation.
        Parameters:
        timestampTo - DateTime

      • getTimestampTo

        public DateTime getTimestampTo()
        Returns the To timestamp for the Activation.
        Returns:
        To timestamp

      • setLastTimeCnt

        public void setLastTimeCnt​(int cnt)
        Sets the count for the last Activation. This has only impact for TimeFrame.LAST.
        Parameters:
        cnt - count for last Activation

      • getLastTimeCnt

        public int getLastTimeCnt()
        Returns the count for the last Activation. This has only impact for TimeFrame.LAST.
        Returns:
        count for last Activation

      • setTimeUnit

        public void setTimeUnit​(TaskFilter.TimeUnit timeUnit)
        Sets the TimeUnit for the last Activation. This has only impact for TimeFrame.LAST.
        Parameters:
        timeUnit - TimeUnit

      • getTimeUnit

        public TaskFilter.TimeUnit getTimeUnit()
        Returns the TimeUnit for the last Activations. This has only impact for TimeFrame.LAST.
        Returns:
        TimeUnit

      • shouldHostAttrTypeEmpty

        public boolean shouldHostAttrTypeEmpty()
        Check if host attribute types list should be empty.
        Returns:
        true, if list of host attribute types should be empty

      • getClientQueues

        public ClientQueueList getClientQueues()
        Gets the client queues.
        Returns:
        the client queues

      • isZduBaseSelect

        public boolean isZduBaseSelect()
        Returns:
        true if zdu base version is selected

      • isZduTargetSelect

        public boolean isZduTargetSelect()
        Returns:
        true if the zdu target version is selected

      • setZduBaseSelect

        public void setZduBaseSelect​(boolean baseSel)
        Sets the zdu base selection to true or false
        Parameters:
        baseSel - ZduBaseSelect

      • setZduTargetSelect

        public void setZduTargetSelect​(boolean targetSel)
        Sets the zdu target selection to true or false
        Parameters:
        targetSel - ZduTargetSelect