Package com.uc4.communication.requests

Class GenericStatistics

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.GenericStatistics
public class GenericStatistics extends XMLRequest
Generic Statistics search.

  • Constructor Details

    • GenericStatistics

      public GenericStatistics()
      Constructs a 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.

  • Method Details

    • getDestinationHost

      public String getDestinationHost()
      Returns the selected destination host.
      Returns:
      String containing a pattern for the selected destination host of a file transfer or UC4 Job

    • setDestinationHost

      public void setDestinationHost(String destinationHost)
      Sets the filter for the destination host of a FileTransfer or UC4 Job. The wildcard characters "*" and "?" can also be used. The tasks of all active hosts are displayed with the default value "*" Only hosts where the pattern matches are returned the result of this search.
      Parameters:
      destinationHost - Pattern conaining the destination host of a FileTransfer or UC4 Job

    • getRunID

      public String getRunID()
      Returns the selected RunID.
      Returns:
      String containing the selected RunID

    • setRunID

      public void setRunID(String runID)
      Sets the filter for the RunID. With the function for saving jobs and job reports in the file system being activated, the corresponding file names are then composed of a 7-figure string (letters). In this case, you may also search for this string instead of the RunID (see also RUNNR2ALPHA)
      Parameters:
      runID - String containing the filter for a specific RunID

    • getTopRunID

      public String getTopRunID()
      Returns the selected topRunID.
      Returns:
      String containing the selected topRunID

    • setTopRunID

      public void setTopRunID(String topRunID)
      Sets the filter for the topRunID. With the function for saving jobs and job reports in the file system being activated, the corresponding file names are then composed of a 7-figure string (letters). In this case, you may also search for this string instead of the RunID (see also RUNNR2ALPHA)
      Parameters:
      topRunID - String containing the filter for a specific topRunID

    • setClient

      public void setClient(int client)
      Sets the client for the statistics search if this request is executed in client zero. To search in all client use -1. If this request is not executed in client zero this property is ignored.
      Parameters:
      client - Client

    • getClient

      public int getClient()
      Returns the client number.
      Returns:
      Client number or -1 for all clients

    • getSourceHost

      public String getSourceHost()
      Returns the selected source host of a FileTransfer.
      Returns:
      Pattern for the source host of a FileTransfer

    • setSourceHost

      public void setSourceHost(String sourceHost)
      Sets the source host of a FileTransfer. Wildcards are supported. Only hosts where the specified pattern matches the source host are returned.
      Parameters:
      sourceHost - Pattern for source host in a FileTransfer

    • isArchiveKeyAndRelation

      public boolean isArchiveKeyAndRelation()
      Returns true if both archive keys must match.
      Returns:
      Boolean indicating the relation of archive keys

    • setArchiveKeyAndRelation

      public void setArchiveKeyAndRelation(boolean archiveKeyAndRelation)
      Sets the relation of archive keys in the filter. if archiveKeyAndRelation is set to true only tasks are returned where both archive keys match. If archiveKeyAndRelation only one archive key must match.
      Parameters:
      archiveKeyAndRelation - Boolean containing the archive key relation

    • getArchiveKey1

      public String getArchiveKey1()
      Returns the first archive key.
      Returns:
      String containing archive key 1

    • setArchiveKey1

      public void setArchiveKey1(String archiveKey1)
      Sets the filter for the first archive key. The wildcard characters "*" and "?" are supported. "?" refers to exactly one, "*" to any characters.
      Parameters:
      archiveKey1 - String containing the first archive key

    • getArchiveKey2

      public String getArchiveKey2()
      Returns the second archive key.
      Returns:
      String containing the second archive key

    • setArchiveKey2

      public void setArchiveKey2(String archiveKey2)
      Sets the filter for the second archive key. The wildcard characters "*" and "?" are supported. "?" refers to exactly one, "*" to any characters.
      Parameters:
      archiveKey2 - String containing the second archive key

    • getStatus

      public String getStatus()
      Returns the selected status for tasks.
      Returns:
      String containing the selected status

    • setStatus

      public void setStatus(String status)
      Sets a filter on the task status.

      Example

       1900      ... returns tasks with status ENDED_OK
 1850,1851 ... returns tasks with a canceled status
 1800-1899 ... returns disrupted tasks
      See the chapter "System Return Codes of Executable Objects" in the UC4 documentation for more information.
      Parameters:
      status - Status

    • setObjectName

      public void setObjectName(String pattern)
      Sets a filter for object names. All objects are returned by default when the wildcard character "*" is used. Use "*" and "?" to specify the filter. "*" refers to any, "?" to exactly one character.
      Parameters:
      pattern - Pattern containing a filter for the object name

    • getAlias

      public String getAlias()
      Returns a filter for the alias.
      Returns:
      Pattern containing a filter for the alias

    • setAlias

      public void setAlias(String alias)
      Sets a filter for alias. All objects are returned by default when the wildcard character "*" is used. Use "*" and "?" to specify the filter. "*" refers to any, "?" to exactly one character.
      Parameters:
      alias - Pattern containing a filter for the alias

    • getPeriodDescription

      public String getPeriodDescription()
      Returns a filter for the period description.
      Returns:
      Pattern containing a filter for the period description

    • setPeriodDescription

      public void setPeriodDescription(String periodDescription)
      Sets a filter for a period description. All objects are returned by default when the wildcard character "*" is used. Use "*" and "?" to specify the filter. "*" refers to any, "?" to exactly one character.
      Parameters:
      periodDescription - Pattern containing a filter for the period description

    • getFromDate

      public DateTime getFromDate()
      Returns the from date for the selection.
      Returns:
      Date when the selection starts

    • setFromDate

      public void setFromDate(DateTime fromDate)
      Sets the from date for the selection.
      Parameters:
      fromDate - Date when the selection starts

    • getToDate

      public DateTime getToDate()
      Returns the until date for the selection.
      Returns:
      Date where the selection ends

    • setToDate

      public void setToDate(DateTime toDate)
      Sets the end date of the selection.
      Parameters:
      toDate - Date where the selection ends

    • selectAllTypes

      public void selectAllTypes()
      Selects all object types.

    • unselectAllTypes

      public void unselectAllTypes()
      Unselects all object types.

    • isTypeAPI

      public boolean isTypeAPI()
      Returns whether the type API is enabled for the search or not.
      Returns:
      Boolean containing true if the type API is enabled

    • isTypeJOBQ

      public boolean isTypeJOBQ()
      Returns whether the type JOBQ is enabled for the search or not.
      Returns:
      Boolean containing true if the type JOBQ is enabled

    • setTypeJOBQ

      public void setTypeJOBQ(boolean typeJOBQ)
      Enables or disables the type JOBQ.
      Parameters:
      typeJOBQ - Boolean which is set to true if JOBQ items should be returned.

    • setTypeAPI

      public void setTypeAPI(boolean typeAPI)
      Enables or disables the type API.
      Parameters:
      typeAPI - Boolean which is set to true if API items should be returned.

    • isTypeCALL

      public boolean isTypeCALL()
      Returns whether the type CALL is enabled for the search or not.
      Returns:
      Boolean containing true if the type CALL is enabled

    • isTypeC_PERIOD

      public boolean isTypeC_PERIOD()
      Returns whether the type period container is enabled for the search or not.
      Returns:
      Boolean containing true if the type period container is enabled

    • setTypeC_PERIOD

      public void setTypeC_PERIOD(boolean typeC_PERIOD)
      Enables or disables the type period container.
      Parameters:
      typeC_PERIOD - Boolean which is set to true if period container items should be returned.

    • isTypeC_HOSTG

      public boolean isTypeC_HOSTG()
      Returns whether the type host group container is enabled for the search or not.
      Returns:
      Boolean containing true if the type host group container is enabled

    • setTypeC_HOSTG

      public void setTypeC_HOSTG(boolean typeC_HOSTG)
      Enables or disables the type host group container.
      Parameters:
      typeC_HOSTG - Boolean which is set to true if host group container items should be returned.

    • setTypeCALL

      public void setTypeCALL(boolean typeCALL)
      Enables or disables the type CALL.
      Parameters:
      typeCALL - Boolean which is set to true if CALL items should be returned.

    • isTypeCLNT

      public boolean isTypeCLNT()
      Returns whether the type CLNT is enabled for the search or not.
      Returns:
      Boolean containing true if the type CLNT is enabled

    • setTypeCLNT

      public void setTypeCLNT(boolean typeCLNT)
      Enables or disables the type CLNT.
      Parameters:
      typeCLNT - Boolean which is set to true if CLNT items should be returned

    • isTypeCPIT

      public boolean isTypeCPIT()
      Returns whether the type CPIT is enabled for the search or not.
      Returns:
      Boolean containing true if the type CPIT is enabled

    • setTypeCPIT

      public void setTypeCPIT(boolean typeCPIT)
      Enables or disables the type CPIT.
      Parameters:
      typeCPIT - Boolean which is set to true if CPIT items should be returned

    • isTypeEVENT_CHILD

      public boolean isTypeEVENT_CHILD()
      Returns whether the type EVENT_CHILD is enabled for the search or not.
      Returns:
      Boolean containing true if the type EVENT_CHILD is enabled

    • setTypeEVENT_CHILD

      public void setTypeEVENT_CHILD(boolean typeEVENT_CHILD)
      Enables or disables the type EVENT_CHILD.
      Parameters:
      typeEVENT_CHILD - Boolean containing true if the type EVENT_CHILD is enabled

    • isTypeEVNT

      public boolean isTypeEVNT()
      Returns whether the type EVENT is enabled for the search or not.
      Returns:
      Boolean containing true if the type EVENT is enabled

    • setTypeEVNT

      public void setTypeEVNT(boolean typeEVNT)
      Enables or disables the type EVENT.
      Parameters:
      typeEVNT - Boolean containing true if the type EVENT is enabled

    • isTypeHOST

      public boolean isTypeHOST()
      Returns whether the type HOST is enabled for the search or not.
      Returns:
      Boolean containing true if the type HOST is enabled

    • setTypeHOST

      public void setTypeHOST(boolean typeHOST)
      Enables or disables the type HOST.
      Parameters:
      typeHOST - Boolean containing true if the type HOST is enabled

    • isTypeJOBD

      public boolean isTypeJOBD()
      Returns whether the type JOBD is enabled for the search or not.
      Returns:
      Boolean containing true if the type JOBD is enabled

    • setTypeJOBD

      public void setTypeJOBD(boolean typeJOBD)
      Enables or disables the type JOBD.
      Parameters:
      typeJOBD - Boolean containing true if the type JOBD is enabled

    • isTypeJOBF

      public boolean isTypeJOBF()
      Returns whether the type JOBF is enabled for the search or not.
      Returns:
      Boolean containing true if the type JOBF is enabled

    • setTypeJOBF

      public void setTypeJOBF(boolean typeJOBF)
      Enables or disables the type JOBF.
      Parameters:
      typeJOBF - Boolean containing true if the type JOBF is enabled

    • isTypeJOBG

      public boolean isTypeJOBG()
      Returns whether the type JOBG is enabled for the search or not.
      Returns:
      Boolean containing true if the type JOBG is enabled

    • setTypeJOBG

      public void setTypeJOBG(boolean typeJOBG)
      Enables or disables the type JOBG.
      Parameters:
      typeJOBG - Boolean containing true if the type JOBG is enabled

    • isTypeJOBP

      public boolean isTypeJOBP()
      Returns whether the type JOBP is enabled for the search or not.
      Returns:
      Boolean containing true if the type JOBP is enabled

    • setTypeJOBP

      public void setTypeJOBP(boolean typeJOBP)
      Enables or disables the type JOBP.
      Parameters:
      typeJOBP - Boolean containing true if the type JOBP is enabled

    • isTypeJOBS

      public boolean isTypeJOBS()
      Returns whether the type JOBS is enabled for the search or not.
      Returns:
      Boolean containing true if the type JOBS is enabled

    • setTypeJOBS

      public void setTypeJOBS(boolean typeJOBS)
      Enables or disables the type JOBS.
      Parameters:
      typeJOBS - Boolean containing true if the type JOBS is enabled

    • isTypeJSCH

      public boolean isTypeJSCH()
      Returns whether the type JSCH is enabled for the search or not.
      Returns:
      Boolean containing true if the type JSCH is enabled

    • setTypeJSCH

      public void setTypeJSCH(boolean typeJSCH)
      Enables or disables the type JSCH.
      Parameters:
      typeJSCH - Boolean containing true if the type JSCH is enabled

    • isTypeREPORT

      public boolean isTypeREPORT()
      Returns whether the type REPORT is enabled for the search or not.
      Returns:
      Boolean containing true if the type REPORT is enabled

    • setTypeREPORT

      public void setTypeREPORT(boolean typeREPORT)
      Enables or disables the type REPORT.
      Parameters:
      typeREPORT - Boolean containing true if the type REPORT is enabled

    • isTypeSCRI

      public boolean isTypeSCRI()
      Returns whether the type SCRI is enabled for the search or not.
      Returns:
      Boolean containing true if the type SCRI is enabled

    • setTypeSCRI

      public void setTypeSCRI(boolean typeSCRI)
      Enables or disables the type SCRI.
      Parameters:
      typeSCRI - Boolean containing true if the type SCRI is enabled

    • isTypeSERV

      public boolean isTypeSERV()
      Returns whether the type SERV is enabled for the search or not.
      Returns:
      Boolean containing true if the type SERV is enabled

    • setTypeSERV

      public void setTypeSERV(boolean typeSERV)
      Enables or disables the type SERV.
      Parameters:
      typeSERV - Boolean containing true if the type SERV is enabled

    • isTypeSYNC

      public boolean isTypeSYNC()
      Returns whether the type SYNC is enabled for the search or not.
      Returns:
      Boolean containing true if the type SYNC is enabled

    • setTypeSYNC

      public void setTypeSYNC(boolean typeSYNC)
      Enables or disables the type SYNC.
      Parameters:
      typeSYNC - Boolean containing true if the type SYNC is enabled

    • isTypeUSER

      public boolean isTypeUSER()
      Returns whether the type USER is enabled for the search or not.
      Returns:
      Boolean containing true if the type USER is enabled

    • setTypeUSER

      public void setTypeUSER(boolean typeUSER)
      Enables or disables the type USER.
      Parameters:
      typeUSER - Boolean containing true if the type USER is enabled

    • setDateSelectionNone

      public void setDateSelectionNone()
      Disables date selection. The date period is not used to select tasks.

    • isDateSelectionNone

      public boolean isDateSelectionNone()
      Returns true if the date selection is disabled.
      Returns:
      Boolean value indicating if the date selection is disabled

    • setDateSelectionActivation

      public void setDateSelectionActivation()
      Selects activation date selection. The specified date period is checked against the activation date of tasks.

    • isDateSelectionActivation

      public boolean isDateSelectionActivation()
      Returns true if activation date selection is used.
      Returns:
      Boolean value indicating a date selection on the activation date of tasks is enabled

    • setDateSelectionStart

      public void setDateSelectionStart()
      Selects the start date of tasks for date selection. The specified date period is checked against the start date of tasks.

    • isDateSelectionStart

      public boolean isDateSelectionStart()
      Returns true if start date selection is used.
      Returns:
      Boolean value indicating a date selection on the start date of tasks is enabled

    • setDateSelectionEnd

      public void setDateSelectionEnd()
      Selects the start date of tasks for date selection. The specified date period is checked against the end date of tasks.

    • isDateSelectionEnd

      public boolean isDateSelectionEnd()
      Returns true if end date selection is used.
      Returns:
      Boolean value indicating a date selection on the end date of tasks is enabled

    • getSrc

      protected String getSrc()
      Description copied from class: XMLRequest
      Returns the request source. This method is used internally.
      Specified by:
      getSrc in class XMLRequest
      Returns:
      Source

    • setQueue

      public void setQueue(String queue)
      Sets the filter for a Queue.
      Parameters:
      queue - Name of the Queue or * to ignore the Queue

    • createRequest

      protected void createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)
      Description copied from class: XMLRequest
      Creates the XML Document for the request. This method is used internally.
      Specified by:
      createRequest in class XMLRequest
      Parameters:
      doc - Document, used to create new Elements
      request - Request Element - classes append information to this request element
      sessionInfo - Information about the session

    • handleContent

      protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Description copied from class: XMLRequest
      Sub classes extract the values from the XML document and provide public getter methods.
      Overrides:
      handleContent in class XMLRequest
      Parameters:
      doc - XML Document
      session - Info about the user session

    • resultIterator

      public Iterator<StatisticSearchItem> resultIterator()
      Returns an iterator over StatisticSearchItem.
      Returns:
      iterator over StatisticSearchItem or null if this request does not contain a search result

    • size

      public int size()
      Returns the number of items in the result.
      Returns:
      Number of StatisticSearchItem items

    • isAllowedInClientZero

      protected boolean isAllowedInClientZero()
      Description copied from class: XMLRequest
      This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.
      Overrides:
      isAllowedInClientZero in class XMLRequest
      Returns:
      true if this request is allowed in client 0, false otherwise

    • 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

    • setPlatformBS2000

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

    • isPlatformCIT

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

    • setPlatformCIT

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

    • isPlatformGCOS8

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

    • setPlatformGCOS8

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

    • isPlatformJMX

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

    • setPlatformJMX

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

    • isPlatformMAIL

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

    • setPlatformMAIL

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

    • isPlatformMPE

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

    • setPlatformMPE

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

    • isPlatformMVS

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

    • setPlatformMVS

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

    • isPlatformNSK

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

    • setPlatformNSK

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

    • isPlatformOA

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

    • setPlatformOA

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

    • isPlatformOS400

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

    • setPlatformOS400

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

    • isPlatformPS

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

    • setPlatformPS

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

    • isPlatformR3

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

    • setPlatformR3

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

    • isPlatformSiebel

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

    • setPlatformSiebel

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

    • isPlatformSQL

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

    • setPlatformSQL

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

    • isPlatformUNIX

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

    • setPlatformUNIX

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

    • isPlatformVMS

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

    • setPlatformVMS

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

    • isPlatformWindows

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

    • setPlatformWindows

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