public class TaskFilter extends ObjectTypeFilter
Modifier and Type | Class and Description |
---|---|
static class |
TaskFilter.TimeFrame
TimeFrame for the activation filter.
|
static class |
TaskFilter.TimeUnit
Time Unit for the Activation filter.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ANY_ABEND
Job disrupted.
|
static java.lang.String |
ANY_ACTIVE
Job is running.
|
static java.lang.String |
ANY_BLOCKING
Blocking tasks.
|
static java.lang.String |
ANY_OK
Job ended normally.
|
static java.lang.String |
ANY_WAITING
Job is waiting.
|
Constructor and Description |
---|
TaskFilter()
Constructs a new
TaskFilter object. |
Modifier and Type | Method and Description |
---|---|
void |
addCustomAttributeFilter(CustomAttributeFilter customAttrFilter)
Adds a
CustomAttributeFilter . |
void |
addQueueFilter(UC4ObjectName queue)
Adds a new item to the filter for Queues.
|
void |
addQueueFilter(UC4ObjectName queue,
int client)
Adds a certain Queue and a client to the filter for Queues.
|
java.util.Iterator<CustomAttributeFilter> |
customAttributeFilterIterator()
Returns an
Iterator over all CustomAttributeFilter . |
java.lang.String |
getArchiveKey1()
Returns the current filter for the first archive key.
|
java.lang.String |
getArchiveKey2()
Returns the current filter for the second archive key.
|
ClientQueueList |
getClientQueues()
Gets the client queues.
|
java.lang.String |
getHost()
Returns the selected hostname.
|
java.util.Set<java.lang.String> |
getHostAttrTypes()
Gets the host attribute types.
|
int |
getLastTimeCnt()
Returns the count for the last Activation.
|
java.lang.String |
getMessageInsert()
Returns the remote status message insert filter.
|
java.lang.String |
getMessageNumber()
Returns the remote status message number filter.
|
java.lang.String |
getObjectName()
Returns the filter for the object name.
|
int |
getParentRunID()
Returns the filter for a parent RunID.
|
java.lang.String |
getPeriodDescription()
Returns the filter for the period description.
|
int |
getQueueClient()
If in client zero, its possible to set a filter for a Queue in a certain client.
|
int |
getQueueClient(int n)
If in client zero, its possible to set a filter for a Queue in a certain client.
|
java.util.List<java.lang.Integer> |
getQueueClientList() |
java.util.List<java.lang.String> |
getQueueList() |
java.lang.String |
getQueueObject() |
java.lang.String |
getQueueObject(int n) |
int |
getQueueObjectCount() |
java.lang.String |
getStatus()
Returns the selected status.
|
TaskFilter.TimeFrame |
getTimeFrame()
Returns the selected Time Frame.
|
DateTime |
getTimestampFrom()
Returns the From timestamp for the Activation.
|
DateTime |
getTimestampTo()
Returns the To timestamp for the Activation.
|
TaskFilter.TimeUnit |
getTimeUnit()
Returns the TimeUnit for the last Activations.
|
int |
getTopRunID()
Returns the filter for a top RunID.
|
java.lang.String |
getUser()
Returns the selected user.
|
boolean |
isArchiveKeyAndRelation()
Returns if tasks should be returned where both archive keys match.
|
boolean |
isExcludeArchiveKey1() |
boolean |
isExcludeArchiveKey2() |
boolean |
isExcludeHost() |
boolean |
isExcludeObjectName() |
boolean |
isExcludePeriodDescription() |
boolean |
isExcludeUser() |
boolean |
isPlatformBS2000()
Returns
true if BS2000 Jobs are selected. |
boolean |
isPlatformCIT()
Returns
true if Rapid Automation Jobs are selected. |
boolean |
isPlatformGCOS8()
Returns
true if GCOS8 Jobs are selected. |
boolean |
isPlatformJMX()
Returns
true if JMX Jobs are selected. |
boolean |
isPlatformMAIL()
Returns
true if MAIL Jobs are selected. |
boolean |
isPlatformMPE()
Returns
true if MPE Jobs are selected. |
boolean |
isPlatformMVS()
Returns
true if MVS Jobs are selected. |
boolean |
isPlatformNSK()
Returns
true if NSK Jobs are selected. |
boolean |
isPlatformOA()
Returns
true if OA Jobs are selected. |
boolean |
isPlatformOS400()
Returns
true if OS400 Jobs are selected. |
boolean |
isPlatformPS()
Returns
true if PS Jobs are selected. |
boolean |
isPlatformR3()
Returns
true if SAP Jobs are selected. |
boolean |
isPlatformSiebel()
Returns
true if Siebel Jobs are selected. |
boolean |
isPlatformSQL()
Returns
true if SQL Jobs are selected. |
boolean |
isPlatformUNIX()
Returns
true if UNIX Jobs are selected. |
boolean |
isPlatformVMS()
Returns
true if VMS Jobs are selected. |
boolean |
isPlatformWindows()
Returns
true if Windows Jobs are selected. |
boolean |
isZduBaseSelect() |
boolean |
isZduTargetSelect() |
void |
removeAllCustomAttributeFilter()
Removes all
CustomAttributeFilter . |
void |
removeCustomAttributeFilter(CustomAttributeFilter customAttrFilter)
Removes a specific
CustomAttributeFilter . |
void |
selectAllPlatforms()
Select all platforms.
|
void |
setArchiveKey1(java.lang.String key1)
Sets the selection for the first archive key.
|
void |
setArchiveKey2(java.lang.String key2)
Sets the selection for the second archive key.
|
void |
setArchiveKeyAndRelation(boolean and)
Sets the relation for archive keys.
|
void |
setExcludeArchiveKey1(boolean excludeArchiveKey1)
If
excludeArchiveKey1 is set to true the Archive Key 1 is excluded from the selection. |
void |
setExcludeArchiveKey2(boolean excludeArchiveKey2)
If
excludeArchiveKey2 is set to true the Archive Key 2 is excluded from the selection. |
void |
setExcludeHost(boolean excludeHost)
If
excludeHost is set to true the HOST is excluded from the selection. |
void |
setExcludeObjectName(boolean excludeObjectName)
If
excludeObjectName is set to true the Object is excluded from the selection. |
void |
setExcludePeriodDescription(boolean excludePeriodDescription)
If
excludePeriodDescription is set to true objects with the
given period description are excluded from the selection. |
void |
setExcludeUser(boolean excludeUser)
If
excludeUser is set to true the user is excluded from the selection. |
void |
setHost(java.lang.String host)
Sets the filter for the host name.
|
void |
setLastTimeCnt(int cnt)
Sets the count for the last Activation.
|
void |
setMessageInsert(java.lang.String messageInsert)
Sets the filter for the remote status message insert.
|
void |
setMessageNumber(int messageNumber)
Sets the filter for the remote status message number.
|
void |
setMessageNumber(java.lang.String messageNumber)
Sets the filter for the remote status message number.
|
void |
setObjectName(java.lang.String filter)
Sets the filter for the object name.
|
void |
setParentRunID(int parentRunID)
Sets a filter for the parent RunID.
|
void |
setPeriodDescription(java.lang.String filter)
Sets the filter for the period description.
|
void |
setPlatformBS2000(boolean platformBS2000)
Select BS2000 Jobs if the parameter
platformBS2000 is true . |
void |
setPlatformCIT(boolean platformCIT)
Select Rapid Automation Jobs if the parameter
platformCIT is true . |
void |
setPlatformGCOS8(boolean platformGCOS8)
Select GCOS8 Jobs if the parameter
platformGCOS8 is true . |
void |
setPlatformJMX(boolean platformJMX)
Select JMX Jobs if the parameter
platformJMX is true . |
void |
setPlatformMAIL(boolean platformMAIL)
Select MAIL Jobs if the parameter
platformMAIL is true . |
void |
setPlatformMPE(boolean platformMPE)
Select MPE Jobs if the parameter
platformMPE is true . |
void |
setPlatformMVS(boolean platformMVS)
Select VMS Jobs if the parameter
platformMVS is true . |
void |
setPlatformNSK(boolean platformNSK)
Select NSK Jobs if the parameter
platformNSK is true . |
void |
setPlatformOA(boolean platformOA)
Select OA Jobs if the parameter
platformOA is true . |
void |
setPlatformOS400(boolean platformOS400)
Select OS400 Jobs if the parameter
platformOS400 is true . |
void |
setPlatformPS(boolean platformPS)
Select PS Jobs if the parameter
platformPS is true . |
void |
setPlatformR3(boolean platformR3)
Select SAP Jobs if the parameter
platformR3 is true . |
void |
setPlatformSiebel(boolean platformSiebel)
Select Siebel Jobs if the parameter
platformSiebel is true . |
void |
setPlatformSQL(boolean platformSQL)
Select SQL Jobs if the parameter
platformSQL is true . |
void |
setPlatformUNIX(boolean platformUNIX)
Select UNIX Jobs if the parameter
platformUNIX is true . |
void |
setPlatformVMS(boolean platformVMS)
Select VMS Jobs if the parameter
platformVMS is true . |
void |
setPlatformWindows(boolean platformWindows)
Select Windows Jobs if the parameter
platformWindows is true . |
void |
setQueueFilter(UC4ObjectName queue)
Sets a filter for Queues.
|
void |
setQueueFilter(UC4ObjectName queue,
int client)
Sets a filter for a certain Queue and a client.
|
void |
setStatus(java.lang.String statusText)
Sets status of selected tasks.
|
void |
setTimeFrame(TaskFilter.TimeFrame timeFrame)
Sets the Activation Time Frame.
|
void |
setTimestampFrom(DateTime timestampFrom)
Sets the From timestamp for the Activation.
|
void |
setTimestampTo(DateTime timestampTo)
Sets the To timestamp for the Activation.
|
void |
setTimeUnit(TaskFilter.TimeUnit timeUnit)
Sets the TimeUnit for the last Activation.
|
void |
setTopRunID(int topRunID)
Sets a filter for the top RunID.
|
void |
setUser(java.lang.String user)
Sets the filter for the user name.
|
void |
setZduBaseSelect(boolean baseSel)
Sets the zdu base selection to true or false
|
void |
setZduTargetSelect(boolean targetSel)
Sets the zdu target selection to true or false
|
boolean |
shouldHostAttrTypeEmpty()
Check if host attribute types list should be empty.
|
void |
unselectAllPlatforms()
Unselect all platforms.
|
getOtypes, isTypeAPI, isTypeC_HOSTG, isTypeC_PERIOD, isTypeCALL, isTypeCAU, isTypeCBCK, isTypeCLNTDEL, isTypeCPIT, isTypeDEPLOY, isTypeEVNT, isTypeGROUP, isTypeHOSTG, isTypeJOBD, isTypeJOBF, isTypeJOBG, isTypeJOBP, isTypeJOBQ, isTypeJOBS, isTypeJSCH, isTypePERIOD, isTypePostEVNT, isTypeREPORT, isTypeSCRI, isTypeUSER, selectAllObjects, selectTaskRelatedObjectTypes, setObjectType, setTypeAPI, setTypeC_HOSTG, setTypeC_PERIOD, setTypeCALL, setTypeCAU, setTypeCBCK, setTypeCLNTDEL, setTypeCPIT, setTypeDEPLOY, setTypeEVNT, setTypeGROUP, setTypeHOSTG, setTypeJOBD, setTypeJOBF, setTypeJOBG, setTypeJOBP, setTypeJOBQ, setTypeJOBS, setTypeJSCH, setTypePERIOD, setTypePostEvnt, setTypeREPORT, setTypeSCRI, setTypeUSER, unselectAllObjects
public static final java.lang.String ANY_ACTIVE
public static final java.lang.String ANY_WAITING
public static final java.lang.String ANY_ABEND
public static final java.lang.String ANY_OK
public static final java.lang.String ANY_BLOCKING
public boolean isExcludeObjectName()
public boolean isExcludePeriodDescription()
public void addQueueFilter(UC4ObjectName queue)
addQueueFilter(UC4ObjectName queue, int client)
instead.queue
- Name of the Queue Objectpublic void addQueueFilter(UC4ObjectName queue, int client)
null
for
the parameter queue
.queue
- Name of the Queue Object or null
client
- UC4 Clientpublic java.lang.String getQueueObject(int n)
n
- the index of the queue object in the filternull
if not set.public int getQueueClient(int n)
setQueueFilter(UC4ObjectName queue, int client)
If not set the return value is -1
.n
- the index of the queue object in the filterpublic java.lang.String getQueueObject()
null
if not set.public int getQueueClient()
setQueueFilter(UC4ObjectName queue, int client)
If not set the return value is -1
.public int getQueueObjectCount()
public java.util.List<java.lang.Integer> getQueueClientList()
public java.util.List<java.lang.String> getQueueList()
public void setExcludeObjectName(boolean excludeObjectName)
excludeObjectName
is set to true
the Object is excluded from the selection.excludeObjectName
- Boolean value to exclude or include the Object name in the selectionpublic void setExcludePeriodDescription(boolean excludePeriodDescription)
excludePeriodDescription
is set to true
objects with the
given period description are excluded from the selection.excludePeriodDescription
- Boolean value to exclude or include the period description in the selectionpublic java.util.Set<java.lang.String> getHostAttrTypes()
public int getParentRunID()
public void setParentRunID(int parentRunID)
parentRunID
- Parent RunID or zero to disable the filterpublic int getTopRunID()
public void setTopRunID(int topRunID)
topRunID
- Top RunID or zero to disable the filterpublic boolean isExcludeUser()
public void setExcludeUser(boolean excludeUser)
excludeUser
is set to true
the user is excluded from the selection.excludeUser
- Boolean value to exclude or include the user in the selectionpublic boolean isExcludeHost()
public void setExcludeHost(boolean excludeHost)
excludeHost
is set to true
the HOST is excluded from the selection.excludeHost
- Boolean value to exclude or include the HOST in the selectionpublic boolean isExcludeArchiveKey1()
public void setExcludeArchiveKey1(boolean excludeArchiveKey1)
excludeArchiveKey1
is set to true
the Archive Key 1 is excluded from the selection.excludeArchiveKey1
- Boolean value to exclude or include the Archive Key 1 in the selectionpublic boolean isExcludeArchiveKey2()
public void setExcludeArchiveKey2(boolean excludeArchiveKey2)
excludeArchiveKey2
is set to true
the Archive Key 2 is excluded from the selection.excludeArchiveKey2
- Boolean value to exclude or include the Archive Key 2 in the selectionpublic java.lang.String getArchiveKey1()
public java.lang.String getArchiveKey2()
public java.lang.String getHost()
public java.lang.String getObjectName()
public java.lang.String getPeriodDescription()
public java.lang.String getStatus()
public java.lang.String getMessageNumber()
public java.lang.String getMessageInsert()
public java.lang.String getUser()
public boolean isArchiveKeyAndRelation()
public void setObjectName(java.lang.String filter)
filter
- Object name filterpublic void setPeriodDescription(java.lang.String filter)
filter
- Object name filterpublic void setQueueFilter(UC4ObjectName queue)
setQueueFilter(UC4ObjectName queue, int client)
instead.queue
- Name of the Queue Objectpublic void setQueueFilter(UC4ObjectName queue, int client)
null
for
the parameter queue
.queue
- Name of the Queue Object or null
client
- UC4 Clientpublic void setArchiveKey1(java.lang.String key1)
key1
- first archive keypublic void setArchiveKey2(java.lang.String key2)
key2
- second archive keypublic void setArchiveKeyAndRelation(boolean and)
and
is true
only tasks where both archive keys match the selection
are returned.and
- true
for AND-Relationpublic void setHost(java.lang.String host)
host
- String containing the pattern of a hostpublic void setStatus(java.lang.String statusText)
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)
statusText
- Statuspublic void setMessageNumber(java.lang.String messageNumber)
messageNumber
- remote status message numberpublic void setMessageNumber(int messageNumber)
messageNumber
- remote status message numberpublic void setMessageInsert(java.lang.String messageInsert)
messageInsert
- remote status message insertpublic void setUser(java.lang.String user)
user
- Userpublic void selectAllPlatforms()
public void unselectAllPlatforms()
public boolean isPlatformBS2000()
true
if BS2000 Jobs are selected.public boolean isPlatformCIT()
true
if Rapid Automation Jobs are selected.public boolean isPlatformGCOS8()
true
if GCOS8 Jobs are selected.public boolean isPlatformJMX()
true
if JMX Jobs are selected.public boolean isPlatformMAIL()
true
if MAIL Jobs are selected.public boolean isPlatformMPE()
true
if MPE Jobs are selected.public boolean isPlatformMVS()
true
if MVS Jobs are selected.public boolean isPlatformNSK()
true
if NSK Jobs are selected.public boolean isPlatformOA()
true
if OA Jobs are selected.public boolean isPlatformOS400()
true
if OS400 Jobs are selected.public boolean isPlatformPS()
true
if PS Jobs are selected.public boolean isPlatformR3()
true
if SAP Jobs are selected.public boolean isPlatformSiebel()
true
if Siebel Jobs are selected.public boolean isPlatformSQL()
true
if SQL Jobs are selected.public boolean isPlatformUNIX()
true
if UNIX Jobs are selected.public boolean isPlatformVMS()
true
if VMS Jobs are selected.public boolean isPlatformWindows()
true
if Windows Jobs are selected.public void setPlatformPS(boolean platformPS)
platformPS
is true
.platformPS
- PS Job selectionpublic void setPlatformMPE(boolean platformMPE)
platformMPE
is true
.platformMPE
- MPE Job selectionpublic void setPlatformNSK(boolean platformNSK)
platformNSK
is true
.platformNSK
- NSK Job selectionpublic void setPlatformMVS(boolean platformMVS)
platformMVS
is true
.platformMVS
- VMS Job selectionpublic void setPlatformJMX(boolean platformJMX)
platformJMX
is true
.platformJMX
- JMX Job selectionpublic void setPlatformMAIL(boolean platformMAIL)
platformMAIL
is true
.platformMAIL
- MAIL Job selectionpublic void setPlatformBS2000(boolean platformBS2000)
platformBS2000
is true
.platformBS2000
- BS2000 Jobs selectionpublic void setPlatformCIT(boolean platformCIT)
platformCIT
is true
.platformCIT
- Rapid Automation Job selectionpublic void setPlatformGCOS8(boolean platformGCOS8)
platformGCOS8
is true
.platformGCOS8
- GCOS8 Job selectionpublic void setPlatformOA(boolean platformOA)
platformOA
is true
.platformOA
- OA Job selectionpublic void setPlatformOS400(boolean platformOS400)
platformOS400
is true
.platformOS400
- OS400 Job selectionpublic void setPlatformR3(boolean platformR3)
platformR3
is true
.platformR3
- SAP Job selectionpublic void setPlatformSiebel(boolean platformSiebel)
platformSiebel
is true
.platformSiebel
- Siebel Job selectionpublic void setPlatformUNIX(boolean platformUNIX)
platformUNIX
is true
.platformUNIX
- UNIX Job selectionpublic void setPlatformVMS(boolean platformVMS)
platformVMS
is true
.platformVMS
- VMS Job selectionpublic void setPlatformSQL(boolean platformSQL)
platformSQL
is true
.platformSQL
- SQL Job selectionpublic void setPlatformWindows(boolean platformWindows)
platformWindows
is true
.platformWindows
- Windows Job selectionpublic void addCustomAttributeFilter(CustomAttributeFilter customAttrFilter)
CustomAttributeFilter
.customAttrFilter
- CustomAttributeFilter
public void removeAllCustomAttributeFilter()
CustomAttributeFilter
.public void removeCustomAttributeFilter(CustomAttributeFilter customAttrFilter)
CustomAttributeFilter
.customAttrFilter
- CustomAttributeFilter
to removepublic java.util.Iterator<CustomAttributeFilter> customAttributeFilterIterator()
Iterator
over all CustomAttributeFilter
.Iterator
over all CustomAttributeFilter
public void setTimeFrame(TaskFilter.TimeFrame timeFrame)
timeFrame
- Time Framepublic TaskFilter.TimeFrame getTimeFrame()
public void setTimestampFrom(DateTime timestampFrom)
timestampFrom
- DateTimepublic DateTime getTimestampFrom()
public void setTimestampTo(DateTime timestampTo)
timestampTo
- DateTimepublic DateTime getTimestampTo()
public void setLastTimeCnt(int cnt)
cnt
- count for last Activationpublic int getLastTimeCnt()
public void setTimeUnit(TaskFilter.TimeUnit timeUnit)
timeUnit
- TimeUnitpublic TaskFilter.TimeUnit getTimeUnit()
public boolean shouldHostAttrTypeEmpty()
public ClientQueueList getClientQueues()
public boolean isZduBaseSelect()
public boolean isZduTargetSelect()
public void setZduBaseSelect(boolean baseSel)
baseSel
- ZduBaseSelectpublic void setZduTargetSelect(boolean targetSel)
targetSel
- ZduTargetSelect