Class Report

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.Report

public class Report extends XMLRequest
Gets a page of a report.
  • Constructor Details

    • Report

      public Report(int runID, String reportType)
      Constructs a ReportContent using the specified runID and reportType.
      Parameters:
      runID - RunID
      reportType - ReportType
  • Method Details

    • getReportType

      public String getReportType()
      Returns the report type.
      • Activation: ACT
      • Agent upgrade: CAU
      • Runtime report: LOG
      • Job, Job report: REP
      • Job, SYSLST: LST
      • Job, structured Job report: SREP
      • Post Process: POST
      • Revision script: REV0
      • Revision JCL: REV1
      • Revision object: REV2
      • Revision client: CLNT
      • Sync: OBJ
      • SAP Jobs, SAP System Log: SLOG
      Returns:
      Abbreviation for the report type
    • firstPage

      public void firstPage()
      Selects the first page of the report.
    • nextPage

      public void nextPage(int page)
      Selects the next page of the report. The parameter currentPage must be filled with old page number.
      Parameters:
      page - Number of the current page
    • specificPage

      public void specificPage(int page)
      Sets a specific page to request The parameter currentPage must be filled with the required page number.
      Parameters:
      page - Number of the requested page (1-based)
    • previousPage

      public void previousPage(int page)
      Selects the previous page. The parameter currentPage must be filled with old page number.
      Parameters:
      page - Number of the current page
    • lastPage

      public void lastPage()
      Selects the last page.
    • 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
    • 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
    • getNumberOfPages

      public int getNumberOfPages()
      Returns the number of pages for this report 0 if this request has not been sent.
      Returns:
      pages
    • getCurrentPage

      public int getCurrentPage()
      Returns the number of the current page or 0 if this request has not been sent.
      Returns:
      page number
    • getReport

      public String getReport()
      Returns the content of this page or null if the request has not been sent.
      Returns:
      page content
    • 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