public class GenericStatistics extends XMLRequest
Constructor and Description |
---|
GenericStatistics()
Constructs a
GenericStatistics . |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAlias()
Returns a filter for the alias.
|
java.lang.String |
getArchiveKey1()
Returns the first archive key.
|
java.lang.String |
getArchiveKey2()
Returns the second archive key.
|
int |
getClient()
Returns the client number.
|
java.lang.String |
getDestinationHost()
Returns the selected destination host.
|
DateTime |
getFromDate()
Returns the from date for the selection.
|
java.lang.String |
getPeriodDescription()
Returns a filter for the period description.
|
java.lang.String |
getRunID()
Returns the selected RunID.
|
java.lang.String |
getSourceHost()
Returns the selected source host of a FileTransfer.
|
java.lang.String |
getStatus()
Returns the selected status for tasks.
|
DateTime |
getToDate()
Returns the until date for the selection.
|
java.lang.String |
getTopRunID()
Returns the selected topRunID.
|
boolean |
isArchiveKeyAndRelation()
Returns
true if both archive keys must match. |
boolean |
isDateSelectionActivation()
Returns
true if activation date selection is used. |
boolean |
isDateSelectionEnd()
Returns
true if end date selection is used. |
boolean |
isDateSelectionNone()
Returns
true if the date selection is disabled. |
boolean |
isDateSelectionStart()
Returns
true if start date selection is used. |
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 |
isTypeAPI()
Returns whether the type API is enabled for the search or not.
|
boolean |
isTypeC_HOSTG()
Returns whether the type host group container is enabled for the search or not.
|
boolean |
isTypeC_PERIOD()
Returns whether the type period container is enabled for the search or not.
|
boolean |
isTypeCALL()
Returns whether the type CALL is enabled for the search or not.
|
boolean |
isTypeCLNT()
Returns whether the type CLNT is enabled for the search or not.
|
boolean |
isTypeCPIT()
Returns whether the type CPIT is enabled for the search or not.
|
boolean |
isTypeEVENT_CHILD()
Returns whether the type EVENT_CHILD is enabled for the search or not.
|
boolean |
isTypeEVNT()
Returns whether the type EVENT is enabled for the search or not.
|
boolean |
isTypeHOST()
Returns whether the type HOST is enabled for the search or not.
|
boolean |
isTypeJOBD()
Returns whether the type JOBD is enabled for the search or not.
|
boolean |
isTypeJOBF()
Returns whether the type JOBF is enabled for the search or not.
|
boolean |
isTypeJOBG()
Returns whether the type JOBG is enabled for the search or not.
|
boolean |
isTypeJOBP()
Returns whether the type JOBP is enabled for the search or not.
|
boolean |
isTypeJOBQ()
Returns whether the type JOBQ is enabled for the search or not.
|
boolean |
isTypeJOBS()
Returns whether the type JOBS is enabled for the search or not.
|
boolean |
isTypeJSCH()
Returns whether the type JSCH is enabled for the search or not.
|
boolean |
isTypeREPORT()
Returns whether the type REPORT is enabled for the search or not.
|
boolean |
isTypeSCRI()
Returns whether the type SCRI is enabled for the search or not.
|
boolean |
isTypeSERV()
Returns whether the type SERV is enabled for the search or not.
|
boolean |
isTypeSYNC()
Returns whether the type SYNC is enabled for the search or not.
|
boolean |
isTypeUSER()
Returns whether the type USER is enabled for the search or not.
|
java.util.Iterator<StatisticSearchItem> |
resultIterator()
Returns an iterator over
StatisticSearchItem . |
void |
selectAllPlatforms()
Select all platforms.
|
void |
selectAllTypes()
Selects all object types.
|
void |
setAlias(java.lang.String alias)
Sets a filter for alias.
|
void |
setArchiveKey1(java.lang.String archiveKey1)
Sets the filter for the first archive key.
|
void |
setArchiveKey2(java.lang.String archiveKey2)
Sets the filter for the second archive key.
|
void |
setArchiveKeyAndRelation(boolean archiveKeyAndRelation)
Sets the relation of archive keys in the filter.
|
void |
setClient(int client)
Sets the client for the statistics search if this request is executed in client zero.
|
void |
setDateSelectionActivation()
Selects activation date selection.
|
void |
setDateSelectionEnd()
Selects the start date of tasks for date selection.
|
void |
setDateSelectionNone()
Disables date selection.
|
void |
setDateSelectionStart()
Selects the start date of tasks for date selection.
|
void |
setDestinationHost(java.lang.String destinationHost)
Sets the filter for the destination host of a FileTransfer or UC4 Job.
|
void |
setFromDate(DateTime fromDate)
Sets the from date for the selection.
|
void |
setObjectName(java.lang.String pattern)
Sets a filter for object names.
|
void |
setPeriodDescription(java.lang.String periodDescription)
Sets a filter for a 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 |
setQueue(java.lang.String queue)
Sets the filter for a Queue.
|
void |
setRunID(java.lang.String runID)
Sets the filter for the RunID.
|
void |
setSourceHost(java.lang.String sourceHost)
Sets the source host of a FileTransfer.
|
void |
setStatus(java.lang.String status)
Sets a filter on the task status.
|
void |
setToDate(DateTime toDate)
Sets the end date of the selection.
|
void |
setTopRunID(java.lang.String topRunID)
Sets the filter for the topRunID.
|
void |
setTypeAPI(boolean typeAPI)
Enables or disables the type API.
|
void |
setTypeC_HOSTG(boolean typeC_HOSTG)
Enables or disables the type host group container.
|
void |
setTypeC_PERIOD(boolean typeC_PERIOD)
Enables or disables the type period container.
|
void |
setTypeCALL(boolean typeCALL)
Enables or disables the type CALL.
|
void |
setTypeCLNT(boolean typeCLNT)
Enables or disables the type CLNT.
|
void |
setTypeCPIT(boolean typeCPIT)
Enables or disables the type CPIT.
|
void |
setTypeEVENT_CHILD(boolean typeEVENT_CHILD)
Enables or disables the type EVENT_CHILD.
|
void |
setTypeEVNT(boolean typeEVNT)
Enables or disables the type EVENT.
|
void |
setTypeHOST(boolean typeHOST)
Enables or disables the type HOST.
|
void |
setTypeJOBD(boolean typeJOBD)
Enables or disables the type JOBD.
|
void |
setTypeJOBF(boolean typeJOBF)
Enables or disables the type JOBF.
|
void |
setTypeJOBG(boolean typeJOBG)
Enables or disables the type JOBG.
|
void |
setTypeJOBP(boolean typeJOBP)
Enables or disables the type JOBP.
|
void |
setTypeJOBQ(boolean typeJOBQ)
Enables or disables the type JOBQ.
|
void |
setTypeJOBS(boolean typeJOBS)
Enables or disables the type JOBS.
|
void |
setTypeJSCH(boolean typeJSCH)
Enables or disables the type JSCH.
|
void |
setTypeREPORT(boolean typeREPORT)
Enables or disables the type REPORT.
|
void |
setTypeSCRI(boolean typeSCRI)
Enables or disables the type SCRI.
|
void |
setTypeSERV(boolean typeSERV)
Enables or disables the type SERV.
|
void |
setTypeSYNC(boolean typeSYNC)
Enables or disables the type SYNC.
|
void |
setTypeUSER(boolean typeUSER)
Enables or disables the type USER.
|
int |
size()
Returns the number of items in the result.
|
void |
unselectAllPlatforms()
Unselect all platforms.
|
void |
unselectAllTypes()
Unselects all object types.
|
getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send
public GenericStatistics()
GenericStatistics
.
This class can be used to get information about already executed tasks.
No object types are selected by default.
The date selection is set to none and no specific status is selected.
The object name filter is set to * which means all objects.
Archive keys and hosts are also set to *.
For archive keys an AND relation is choosen as default.public java.lang.String getDestinationHost()
public void setDestinationHost(java.lang.String destinationHost)
destinationHost
- Pattern conaining the destination host of a FileTransfer or UC4 Jobpublic java.lang.String getRunID()
public void setRunID(java.lang.String runID)
runID
- String containing the filter for a specific RunIDpublic java.lang.String getTopRunID()
public void setTopRunID(java.lang.String topRunID)
topRunID
- String containing the filter for a specific topRunIDpublic void setClient(int client)
-1
.
If this request is not executed in client zero this property is ignored.client
- Clientpublic int getClient()
-1
for all clientspublic java.lang.String getSourceHost()
public void setSourceHost(java.lang.String sourceHost)
sourceHost
- Pattern for source host in a FileTransferpublic boolean isArchiveKeyAndRelation()
true
if both archive keys must match.public void setArchiveKeyAndRelation(boolean archiveKeyAndRelation)
archiveKeyAndRelation
is set to true
only tasks are returned where both archive keys match.
If archiveKeyAndRelation
only one archive key must match.archiveKeyAndRelation
- Boolean containing the archive key relationpublic java.lang.String getArchiveKey1()
public void setArchiveKey1(java.lang.String archiveKey1)
archiveKey1
- String containing the first archive keypublic java.lang.String getArchiveKey2()
public void setArchiveKey2(java.lang.String archiveKey2)
archiveKey2
- String containing the second archive keypublic java.lang.String getStatus()
public void setStatus(java.lang.String status)
Example
1900 ... returns tasks with status ENDED_OK 1850,1851 ... returns tasks with a canceled status 1800-1899 ... returns disrupted tasksSee the chapter "System Return Codes of Executable Objects" in the UC4 documentation for more information.
status
- Statuspublic void setObjectName(java.lang.String pattern)
pattern
- Pattern containing a filter for the object namepublic java.lang.String getAlias()
public void setAlias(java.lang.String alias)
alias
- Pattern containing a filter for the aliaspublic java.lang.String getPeriodDescription()
public void setPeriodDescription(java.lang.String periodDescription)
periodDescription
- Pattern containing a filter for the period descriptionpublic DateTime getFromDate()
public void setFromDate(DateTime fromDate)
fromDate
- Date when the selection startspublic DateTime getToDate()
public void setToDate(DateTime toDate)
toDate
- Date where the selection endspublic void selectAllTypes()
public void unselectAllTypes()
public boolean isTypeAPI()
true
if the type API is enabledpublic boolean isTypeJOBQ()
true
if the type JOBQ is enabledpublic void setTypeJOBQ(boolean typeJOBQ)
typeJOBQ
- Boolean which is set to true
if JOBQ items should be returned.public void setTypeAPI(boolean typeAPI)
typeAPI
- Boolean which is set to true
if API items should be returned.public boolean isTypeCALL()
true
if the type CALL is enabledpublic boolean isTypeC_PERIOD()
true
if the type period container is enabledpublic void setTypeC_PERIOD(boolean typeC_PERIOD)
typeC_PERIOD
- Boolean which is set to true
if period container items should be returned.public boolean isTypeC_HOSTG()
true
if the type host group container is enabledpublic void setTypeC_HOSTG(boolean typeC_HOSTG)
typeC_HOSTG
- Boolean which is set to true
if host group container items should be returned.public void setTypeCALL(boolean typeCALL)
typeCALL
- Boolean which is set to true
if CALL items should be returned.public boolean isTypeCLNT()
true
if the type CLNT is enabledpublic void setTypeCLNT(boolean typeCLNT)
typeCLNT
- Boolean which is set to true
if CLNT items should be returnedpublic boolean isTypeCPIT()
true
if the type CPIT is enabledpublic void setTypeCPIT(boolean typeCPIT)
typeCPIT
- Boolean which is set to true
if CPIT items should be returnedpublic boolean isTypeEVENT_CHILD()
true
if the type EVENT_CHILD is enabledpublic void setTypeEVENT_CHILD(boolean typeEVENT_CHILD)
typeEVENT_CHILD
- Boolean containing true
if the type EVENT_CHILD is enabledpublic boolean isTypeEVNT()
true
if the type EVENT is enabledpublic void setTypeEVNT(boolean typeEVNT)
typeEVNT
- Boolean containing true
if the type EVENT is enabledpublic boolean isTypeHOST()
true
if the type HOST is enabledpublic void setTypeHOST(boolean typeHOST)
typeHOST
- Boolean containing true
if the type HOST is enabledpublic boolean isTypeJOBD()
true
if the type JOBD is enabledpublic void setTypeJOBD(boolean typeJOBD)
typeJOBD
- Boolean containing true
if the type JOBD is enabledpublic boolean isTypeJOBF()
true
if the type JOBF is enabledpublic void setTypeJOBF(boolean typeJOBF)
typeJOBF
- Boolean containing true
if the type JOBF is enabledpublic boolean isTypeJOBG()
true
if the type JOBG is enabledpublic void setTypeJOBG(boolean typeJOBG)
typeJOBG
- Boolean containing true
if the type JOBG is enabledpublic boolean isTypeJOBP()
true
if the type JOBP is enabledpublic void setTypeJOBP(boolean typeJOBP)
typeJOBP
- Boolean containing true
if the type JOBP is enabledpublic boolean isTypeJOBS()
true
if the type JOBS is enabledpublic void setTypeJOBS(boolean typeJOBS)
typeJOBS
- Boolean containing true
if the type JOBS is enabledpublic boolean isTypeJSCH()
true
if the type JSCH is enabledpublic void setTypeJSCH(boolean typeJSCH)
typeJSCH
- Boolean containing true
if the type JSCH is enabledpublic boolean isTypeREPORT()
true
if the type REPORT is enabledpublic void setTypeREPORT(boolean typeREPORT)
typeREPORT
- Boolean containing true
if the type REPORT is enabledpublic boolean isTypeSCRI()
true
if the type SCRI is enabledpublic void setTypeSCRI(boolean typeSCRI)
typeSCRI
- Boolean containing true
if the type SCRI is enabledpublic boolean isTypeSERV()
true
if the type SERV is enabledpublic void setTypeSERV(boolean typeSERV)
typeSERV
- Boolean containing true
if the type SERV is enabledpublic boolean isTypeSYNC()
true
if the type SYNC is enabledpublic void setTypeSYNC(boolean typeSYNC)
typeSYNC
- Boolean containing true
if the type SYNC is enabledpublic boolean isTypeUSER()
true
if the type USER is enabledpublic void setTypeUSER(boolean typeUSER)
typeUSER
- Boolean containing true
if the type USER is enabledpublic void setDateSelectionNone()
public boolean isDateSelectionNone()
true
if the date selection is disabled.public void setDateSelectionActivation()
public boolean isDateSelectionActivation()
true
if activation date selection is used.public void setDateSelectionStart()
public boolean isDateSelectionStart()
true
if start date selection is used.public void setDateSelectionEnd()
public boolean isDateSelectionEnd()
true
if end date selection is used.public void setQueue(java.lang.String queue)
queue
- Name of the Queue or * to ignore the Queuepublic java.util.Iterator<StatisticSearchItem> resultIterator()
StatisticSearchItem
.StatisticSearchItem
or null
if this request
does not contain a search resultpublic int size()
StatisticSearchItem
itemspublic void selectAllPlatforms()
public void unselectAllPlatforms()
public boolean isPlatformBS2000()
true
if BS2000 Jobs are selected.public void setPlatformBS2000(boolean platformBS2000)
platformBS2000
is true
.platformBS2000
- BS2000 Jobs selectionpublic boolean isPlatformCIT()
true
if Rapid Automation Jobs are selected.public void setPlatformCIT(boolean platformCIT)
platformCIT
is true
.platformCIT
- Rapid Automation Job selectionpublic boolean isPlatformGCOS8()
true
if GCOS8 Jobs are selected.public void setPlatformGCOS8(boolean platformGCOS8)
platformGCOS8
is true
.platformGCOS8
- GCOS8 Job selectionpublic boolean isPlatformJMX()
true
if JMX Jobs are selected.public void setPlatformJMX(boolean platformJMX)
platformJMX
is true
.platformJMX
- JMX Job selectionpublic boolean isPlatformMAIL()
true
if MAIL Jobs are selected.public void setPlatformMAIL(boolean platformMAIL)
platformMAIL
is true
.platformMAIL
- MAIL Job selectionpublic boolean isPlatformMPE()
true
if MPE Jobs are selected.public void setPlatformMPE(boolean platformMPE)
platformMPE
is true
.platformMPE
- MPE Job selectionpublic boolean isPlatformMVS()
true
if MVS Jobs are selected.public void setPlatformMVS(boolean platformMVS)
platformMVS
is true
.platformMVS
- VMS Job selectionpublic boolean isPlatformNSK()
true
if NSK Jobs are selected.public void setPlatformNSK(boolean platformNSK)
platformNSK
is true
.platformNSK
- NSK Job selectionpublic boolean isPlatformOA()
true
if OA Jobs are selected.public void setPlatformOA(boolean platformOA)
platformOA
is true
.platformOA
- OA Job selectionpublic boolean isPlatformOS400()
true
if OS400 Jobs are selected.public void setPlatformOS400(boolean platformOS400)
platformOS400
is true
.platformOS400
- OS400 Job selectionpublic boolean isPlatformPS()
true
if PS Jobs are selected.public void setPlatformPS(boolean platformPS)
platformPS
is true
.platformPS
- PS Job selectionpublic boolean isPlatformR3()
true
if SAP Jobs are selected.public void setPlatformR3(boolean platformR3)
platformR3
is true
.platformR3
- SAP Job selectionpublic boolean isPlatformSiebel()
true
if Siebel Jobs are selected.public void setPlatformSiebel(boolean platformSiebel)
platformSiebel
is true
.platformSiebel
- Siebel Job selectionpublic boolean isPlatformSQL()
true
if SQL Jobs are selected.public void setPlatformSQL(boolean platformSQL)
platformSQL
is true
.platformSQL
- SQL Job selectionpublic boolean isPlatformUNIX()
true
if UNIX Jobs are selected.public void setPlatformUNIX(boolean platformUNIX)
platformUNIX
is true
.platformUNIX
- UNIX Job selectionpublic boolean isPlatformVMS()
true
if VMS Jobs are selected.public void setPlatformVMS(boolean platformVMS)
platformVMS
is true
.platformVMS
- VMS Job selectionpublic boolean isPlatformWindows()
true
if Windows Jobs are selected.public void setPlatformWindows(boolean platformWindows)
platformWindows
is true
.platformWindows
- Windows Job selection