OPRO X Server Management Service API

net.opro.product.odcaw.api
Interface OXSMSResponse

All Superinterfaces:
Response
All Known Implementing Classes:
OXSMSAsyncResponse, OXSMSSyncResponse

public interface OXSMSResponse
extends Response

A interface which provides a mechanism to operate about the result of the directions to OXSMS from OXSMSHandler.

Version:
2.5.0.0
Author:
OPRO Japan Co.,Ltd. R&D Center
See Also:
OXSMSHandler.syncCreate, OXSMSHandler.syncPrint, OXSMSHandler.syncFax, OXSMSHandler.syncFaxA, OXSMSHandler.syncFaxI, OXSMSHandler.syncMail, OXSMSHandler.asyncCreate, OXSMSHandler.asyncPrint, OXSMSHandler.asyncFax, OXSMSHandler.asyncFaxA, OXSMSHandler.asyncFaxI, OXSMSHandler.asyncMail

Method Summary
 boolean containsAdditionalParameter(String name)
          Returns true when specified parameter is contained in parameters which are added by addAdditionalParameter.
 String[] getAdditionalParameter(String name)
          Returns value of specified parameter which is sent to OXSMS, added by addAdditionalParameter.
When specified parameter is not exists, returns null.
 String getAidParameter()
          Returns the request parameter name of Foreign Application ID which is set in OXSMSHandler.setAidParameter.
 String getAidValue()
          Returns Foreign Application ID which is set in OXSMSHandler.setAidValue.
 String getCommentParameter()
          Returns the request parameter name of Comment which is set in OXSMSHandler.setCommentParameter.
 String getCommentValue()
          Returns Comment which is set in OXSMSHandler.setCommentValue.
 String getOXSAddress()
          Returns IP address of OXS that OXSMS actually uses.
 String getOXSAlias()
          Returns OXS Alias that OXSMS actually uses.
 String getOXSParameter()
          Returns the request parameter name of OXS Alias which is set in OXSMSHandler.setOXSParameter.
 int getOXSPort()
          Returns port number of OXS that OXSMS actually uses.
 String getOXSValue()
          Returns OXS Alias which is set in OXSMSHandler.setOXSValue.
 String getRequestID()
          Returns Request ID newly numbered for the request to OXSMS.
 String getRidParameter()
          Returns the request parameter name of Request ID which is set in OXSMSHandler.setRidParameter.
 String getRidValue()
          Returns Request ID which is set in OXSMSHandler.setRidValue.
 String getTCABParameter()
          Returns the request parameter name of Use Ricoh TrustyCabinet which is set in OXSMSHandler.setTCABParameter.
 boolean getTCABValue()
          Returns a boolean indicating whether or not Ricoh TrustyCabinet should be used.
 String getUidParameter()
          Returns the request parameter name of User ID which is set in OXSMSHandler.setUidParameter.
 String getUidValue()
          Returns User ID which is set in OXSMSHandler.setUidValue.
 
Methods inherited from interface Response
getAddress, getDocument, getDocumentUrl, getPort, getResult
 

Method Detail

getRequestID

public String getRequestID()
Returns Request ID newly numbered for the request to OXSMS.

Returns:
Request ID

getOXSAlias

public String getOXSAlias()
Returns OXS Alias that OXSMS actually uses. This is equal to OXS Alias set in setOXSValue.

Returns:
OXS Alias
Since:
2006.04.13

getOXSAddress

public String getOXSAddress()
Returns IP address of OXS that OXSMS actually uses. This is either of IP address of two or more OXS included in one OXS alias.

Returns:
IP address of OXS that OXSMS actually uses
Since:
2006.04.13

getOXSPort

public int getOXSPort()
Returns port number of OXS that OXSMS actually uses. This is either of port number of two or more OXS included in one OXS alias.

Returns:
Port number of OXS that OXSMS actually uses
Since:
2006.04.13

getAidValue

public String getAidValue()
Returns Foreign Application ID which is set in OXSMSHandler.setAidValue.

Returns:
Foreign Application ID
Since:
2006.04.13
See Also:
OXSMSHandler.getAidValue

getCommentValue

public String getCommentValue()
Returns Comment which is set in OXSMSHandler.setCommentValue.

Returns:
Comment
Since:
2006.04.13
See Also:
OXSMSHandler.getCommentValue

getOXSValue

public String getOXSValue()
Returns OXS Alias which is set in OXSMSHandler.setOXSValue.

Returns:
OXS Alias
Since:
2006.04.13
See Also:
OXSMSHandler.getOXSValue

getRidValue

public String getRidValue()
Returns Request ID which is set in OXSMSHandler.setRidValue.

Returns:
Request ID
Since:
2006.04.13
See Also:
OXSMSHandler.getRidValue

getTCABValue

public boolean getTCABValue()
Returns a boolean indicating whether or not Ricoh TrustyCabinet should be used.

Returns:
a boolean indicating whether or not to use Ricoh TrustyCabinet
Since:
2006.04.13
See Also:
OXSMSHandler.getTCABValue

getUidValue

public String getUidValue()
Returns User ID which is set in OXSMSHandler.setUidValue.

Returns:
User ID
Since:
2006.04.13
See Also:
OXSMSHandler.getUidValue

getAidParameter

public String getAidParameter()
Returns the request parameter name of Foreign Application ID which is set in OXSMSHandler.setAidParameter.

Returns:
the request parameter name of Foreign Application ID
Since:
2006.04.13
See Also:
OXSMSHandler.getAidParameter

getCommentParameter

public String getCommentParameter()
Returns the request parameter name of Comment which is set in OXSMSHandler.setCommentParameter.

Returns:
the request parameter name of Comment
Since:
2006.04.13
See Also:
OXSMSHandler.getCommentParameter

getOXSParameter

public String getOXSParameter()
Returns the request parameter name of OXS Alias which is set in OXSMSHandler.setOXSParameter.

Returns:
the request parameter name of OXS Alias
Since:
2006.04.13
See Also:
OXSMSHandler.getOXSParameter

getRidParameter

public String getRidParameter()
Returns the request parameter name of Request ID which is set in OXSMSHandler.setRidParameter.

Returns:
the request parameter name of Request ID
Since:
2006.04.13
See Also:
OXSMSHandler.getRidParameter

getTCABParameter

public String getTCABParameter()
Returns the request parameter name of Use Ricoh TrustyCabinet which is set in OXSMSHandler.setTCABParameter.

Returns:
the request parameter name of Use Ricoh TrustyCabinet
Since:
2006.04.13
See Also:
OXSMSHandler.getTCABParameter

getUidParameter

public String getUidParameter()
Returns the request parameter name of User ID which is set in OXSMSHandler.setUidParameter.

Returns:
the request parameter name of User ID
Since:
2006.04.13
See Also:
OXSMSHandler.getUidParameter

getAdditionalParameter

public String[] getAdditionalParameter(String name)
Returns value of specified parameter which is sent to OXSMS, added by addAdditionalParameter.
When specified parameter is not exists, returns null.

Parameters:
name - Name of parameter to get
Returns:
Value of parameter to be got
Since:
2006.08.01
See Also:
addAdditionalParameter

containsAdditionalParameter

public boolean containsAdditionalParameter(String name)
Returns true when specified parameter is contained in parameters which are added by addAdditionalParameter.

Parameters:
name - Name of parameter to check
Returns:
When parameter is contained in added paramters, returns true
Since:
2006.08.01
See Also:
addAdditionalParameter

OPRO Japan Co.,Ltd.