Package com.uc4.communication.requests
Class Report
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.Report
Gets a page of a report.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
createRequest
(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.void
Selects the first page of the report.int
Returns the number of the current page or 0 if this request has not been sent.int
Returns the number of pages for this report 0 if this request has not been sent.Returns the content of this page ornull
if the request has not been sent.Returns the report type.protected String
getSrc()
Returns the request source.protected void
handleContent
(com.uc4.util.XMLDocument doc, ConnectionAttributes session) Sub classes extract the values from the XML document and provide public getter methods.protected boolean
This method is used internally.void
lastPage()
Selects the last page.void
nextPage
(int page) Selects the next page of the report.void
previousPage
(int page) Selects the previous page.void
specificPage
(int page) Sets a specific page to request The parametercurrentPage
must be filled with the required page number.Methods inherited from class com.uc4.communication.requests.XMLRequest
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification
-
Constructor Details
-
Report
Constructs aReportContent
using the specifiedrunID
andreportType
.- Parameters:
runID
- RunIDreportType
- ReportType
-
-
Method Details
-
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 parametercurrentPage
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 parametercurrentPage
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 parametercurrentPage
must be filled with old page number.- Parameters:
page
- Number of the current page
-
lastPage
public void lastPage()Selects the last page. -
getSrc
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- 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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the session
-
handleContent
Description copied from class:XMLRequest
Sub classes extract the values from the XML document and provide public getter methods.- Overrides:
handleContent
in classXMLRequest
- Parameters:
doc
- XML Documentsession
- 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
Returns the content of this page ornull
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 thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- Returns:
true
if this request is allowed in client 0,false
otherwise
-