OPRO X Server Management Service API

net.opro.product.odcaw.api
Class OXSMSAcquireResponse

Object
  extended bySyncResponse
      extended byOXSMSSyncResponse
          extended byOXSMSAcquireResponse
All Implemented Interfaces:
OXSMSResponse, Response

public class OXSMSAcquireResponse
extends OXSMSSyncResponse

This class is the return value of OXSMSHandler.acquireDocument and provides the result.
It is possible to get the Request ID, document, its content-type and more.

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

Method Summary
 String getContentType()
          Returns content-type of document which is obtained by getDocument.
 InputStream getDocument()
          Returns input stream to receive document.
 String getDocumentUrl()
          Returns always null.
 String getOXSAddress()
          Returns always null.
 String getOXSAlias()
          Returns always null.
 int getOXSPort()
          Returns always zero.
 int getResult()
          Returns always OXSHandler.STATUS_COMPLETE.
 
Methods inherited from class OXSMSSyncResponse
containsAdditionalParameter, getAdditionalParameter, getAidParameter, getAidValue, getCommentParameter, getCommentValue, getOXSParameter, getOXSValue, getRequestID, getRidParameter, getRidValue, getTCABParameter, getTCABValue, getUidParameter, getUidValue
 
Methods inherited from class SyncResponse
getAddress, getPort
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface Response
getAddress, getPort
 

Method Detail

getDocumentUrl

public String getDocumentUrl()
Returns always null.

Returns:
always null

getDocument

public InputStream getDocument()
                                throws IOException
Returns input stream to receive document.

Specified by:
getDocument in interface Response
Overrides:
getDocument in class OXSMSSyncResponse
Returns:
input stream to receive document
Throws:
IOException - not thrown

getResult

public int getResult()
Returns always OXSHandler.STATUS_COMPLETE.

Returns:
always OXSHandler.STATUS_COMPLETE

getContentType

public String getContentType()
Returns content-type of document which is obtained by getDocument.

Returns:
content-type of document which is obtained by getDocument

getOXSAlias

public String getOXSAlias()
Returns always null.

Specified by:
getOXSAlias in interface OXSMSResponse
Overrides:
getOXSAlias in class OXSMSSyncResponse
Returns:
always null
Since:
2006.04.13

getOXSAddress

public String getOXSAddress()
Returns always null.

Specified by:
getOXSAddress in interface OXSMSResponse
Overrides:
getOXSAddress in class OXSMSSyncResponse
Returns:
always null
Since:
2006.04.13

getOXSPort

public int getOXSPort()
Returns always zero.

Specified by:
getOXSPort in interface OXSMSResponse
Overrides:
getOXSPort in class OXSMSSyncResponse
Returns:
always zero
Since:
2006.04.13

OPRO Japan Co.,Ltd.