OPRO X Server Management Service API

net.opro.product.odcaw.api
Class OXSMSLogResponse

Object
  extended byOXSMSLogResponse

public class OXSMSLogResponse
extends Object

This class is the return value of OXSMSHandler.getLog, OXSMSHandler.getLogByApplicationID and provides the result.

Version:
2.5.0.0
Author:
OPRO Japan Co.,Ltd. R&D Center
See Also:
OXSMSHandler.getLog, OXSMSHandler.getLogByApplicationID

Method Summary
 String getAcquireUrl()
          Returns URL to acquire the document corresponding to the log.
If default Log Response JSP file is used, if there is no document corresponding to the log, empty String is returned.
 String getApplicationID()
          Returns Foreign Application ID which is contained in the log.
 String getComment()
          Returns Comment which is contained in the log.
 String getCreate()
          Returns Request Date which is contained in the log in String.
If default Log Response JSP file is used, the format is yyyy/MM/dd HH:mm:ss.
 String getLogUrl()
          Returns URL to get the detail of the log.
 String getOP()
          Returns the value of OP parameter of query string for OXS which is contained in the log.
If the operation of the log is Document acquisition, msdlis returned.
 String getOriginalID()
          Returns Original ID which is contained in the log.
If the operation of the log is Document acquisition or Document recycling using oxsms:// scheme, the returning value shows the original Request ID.
 String getOXSAddress()
          Returns IP address (host name) of OXS which is contained in the log.
If the log doesn't accompany the request to OXS, empty String is returned.
 String getOXSPID()
          Returns process number (PID) of OXS which is contained in the log.
If the log doesn't accompany the request to OXS, empty String is returned.
 String getOXSPort()
          Returns port number of OXS which is contained in the log.
If the log doesn't accompany the request to OXS, empty String is returned.
 String getOXSQueryString()
          Returns query string for OXS which is contained in the log.
If the log doesn't accompany the request to OXS, empty String is returned.
 String getOXSStatus()
          Returns status of the process of OXS that is shown by getOXSPID of point to acquire the log.
If the log doesn't accompany the request to OXS, empty String is returned.
 String getRequestID()
          Returns Request ID which is contained in the log.
 String getRerequestUrl()
          Returns URL to request to OXS again.
 String getTP()
          Returns the value of TP parameter of query string for OXS which is contained in the log.
If the operation of the log is Document acquisition or Document recycling using oxsms:// scheme, oxsms://tp/acquisition or oxsms://tp/dcrequest is returned.
 String getUserID()
          Returns User ID which is contained in the log.
 String getValue(String name)
          Returns the value of any meta tag which is written in Log Response JSP file.
When Log Response JSP file is customized, and additional information is received from OXSMS, this method is used.
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getRequestID

public String getRequestID()
Returns Request ID which is contained in the log.

Returns:
Request ID which is contained in the log

getUserID

public String getUserID()
Returns User ID which is contained in the log.

Returns:
User ID which is contained in the log

getCreate

public String getCreate()
Returns Request Date which is contained in the log in String.
If default Log Response JSP file is used, the format is yyyy/MM/dd HH:mm:ss.

Returns:
Request Date which is contained in the log

getOriginalID

public String getOriginalID()
Returns Original ID which is contained in the log.
If the operation of the log is Document acquisition or Document recycling using oxsms:// scheme, the returning value shows the original Request ID.

Returns:
Returns Original ID which is contained in the log

getApplicationID

public String getApplicationID()
Returns Foreign Application ID which is contained in the log.

Returns:
Returns Foreign Application ID which is contained in the log

getAcquireUrl

public String getAcquireUrl()
Returns URL to acquire the document corresponding to the log.
If default Log Response JSP file is used, if there is no document corresponding to the log, empty String is returned.

Returns:
URL to acquire the document corresponding to the log

getRerequestUrl

public String getRerequestUrl()
Returns URL to request to OXS again. Returning value shows the same request when the log was made.
If default Log Response JSP file is used, if the log does not have request to OXS, empty String is returned.

Returns:
Returns URL to request to OXS again

getLogUrl

public String getLogUrl()
Returns URL to get the detail of the log.

Returns:
Returns URL to get the detail of the log

getComment

public String getComment()
Returns Comment which is contained in the log.

Returns:
Comment which is contained in the log

getOXSPID

public String getOXSPID()
Returns process number (PID) of OXS which is contained in the log.
If the log doesn't accompany the request to OXS, empty String is returned.

Returns:
process number (PID) of OXS which is contained in the log

getOXSAddress

public String getOXSAddress()
Returns IP address (host name) of OXS which is contained in the log.
If the log doesn't accompany the request to OXS, empty String is returned.

Returns:
IP address (host name) of OXS which is contained in the log

getOXSPort

public String getOXSPort()
Returns port number of OXS which is contained in the log.
If the log doesn't accompany the request to OXS, empty String is returned.

Returns:
port number of OXS which is contained in the log

getOXSQueryString

public String getOXSQueryString()
Returns query string for OXS which is contained in the log.
If the log doesn't accompany the request to OXS, empty String is returned.

Returns:
query string for OXS which is contained in the log

getTP

public String getTP()
Returns the value of TP parameter of query string for OXS which is contained in the log.
If the operation of the log is Document acquisition or Document recycling using oxsms:// scheme, oxsms://tp/acquisition or oxsms://tp/dcrequest is returned.

Returns:
the value of TP parameter of query string for OXS which is contained in the log

getOP

public String getOP()
Returns the value of OP parameter of query string for OXS which is contained in the log.
If the operation of the log is Document acquisition, msdlis returned.

Returns:
the value of OP parameter of query string for OXS which is contained in the log

getOXSStatus

public String getOXSStatus()
Returns status of the process of OXS that is shown by getOXSPID of point to acquire the log.
If the log doesn't accompany the request to OXS, empty String is returned.

Returns:
status of the process of OXS of point to acquire the log

getValue

public String getValue(String name)
Returns the value of any meta tag which is written in Log Response JSP file.
When Log Response JSP file is customized, and additional information is received from OXSMS, this method is used.

meta tag of Log Response JSP file should be in the form of the following.
<meta name="any unique name" content="any value" />
When the name attribute value is specified by argument name, the content attribute value is returned.

Parameters:
name - the name attribute value of meta tag to get content attribute value
Returns:
content attribute value

OPRO Japan Co.,Ltd.