com.ibm.ctc.b2b.response

Class ResponseDocument

java.lang.Object

com.ibm.ctc.b2b.response.ResponseDocument

Direct Known Subclasses:

ErrorResponse, OrderResponse, ProfileResponse, PunchOutOrderMessage, PunchOutSetupResponse

public abstract class ResponseDocument
extends java.lang.Object

This class provides function for creating a basic shell for a response cXML document. Subclasses are used for specific response types.

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	CLASSNAME
(package private) static java.lang.String	COPYRIGHT
private static org.apache.log4j.Logger	logger
protected org.dom4j.Document	requestDocument
protected org.dom4j.Document	responseDocument
protected org.dom4j.Element	responseElement
private Status	status
private org.dom4j.Element	statusElement

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ResponseDocument(org.dom4j.Document theRequestDoc) Create a response document, based on the request type.

Method Summary

Modifier and Type	Method and Description
protected abstract org.dom4j.Element	addResponseSpecificElement() Hook for subclasses to add elements specific to the response type when the response shell is built.
protected org.dom4j.Element	addStatusElement() Creates the status element including attributes.
protected org.dom4j.Element	createCxmlShell() Creates the cXML element and attribtues.
protected org.dom4j.Document	createShell() Creates the response document shell containing the cXML node and the response node, resulting in a XML document as follows: The cXML node is a clone of the request cXML node with the timestamp updated.
org.dom4j.Document	getResponseDocument()
protected org.dom4j.Element	getResponseElement()
java.lang.String	getStatusReturnCode() Gets the return code in the response.
java.lang.String	getStatusText() Gets the status text in the response.
protected boolean	isStatusSuccess() Returns if this result indicates success.
static void	main(java.lang.String[] args) Used for testing only.
void	setStatus(Status status) Sets the status in the response.
void	setStatusReturnCode(int rc) Sets the return code in the response.
void	setStatusText(java.lang.String msg) Sets the status text in the response.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT

See Also:

Constant Field Values

CLASSNAME

private static final java.lang.String CLASSNAME

logger

private static org.apache.log4j.Logger logger

requestDocument

protected org.dom4j.Document requestDocument

responseDocument

protected org.dom4j.Document responseDocument

responseElement

protected org.dom4j.Element responseElement

statusElement

private org.dom4j.Element statusElement

status

private Status status

Constructor Detail

ResponseDocument

protected ResponseDocument(org.dom4j.Document theRequestDoc)

Create a response document, based on the request type. Resulting document will have the basic response shell afer createShell() is called. Users of this class should create response documents via the ResponseDocumentFactory class, which calls createShell().

Method Detail

createShell

protected org.dom4j.Document createShell()
                                  throws java.lang.Exception

Creates the response document shell containing the cXML node and the response node, resulting in a XML document as follows: The cXML node is a clone of the request cXML node with the timestamp updated.

Throws:

java.lang.Exception

createCxmlShell

protected org.dom4j.Element createCxmlShell()
                                     throws java.lang.Exception

Creates the cXML element and attribtues.

Returns:

the created cXML element

Throws:

java.lang.Exception

addResponseSpecificElement

protected abstract org.dom4j.Element addResponseSpecificElement()
                                                         throws java.lang.Exception

Hook for subclasses to add elements specific to the response type when the response shell is built.

Throws:

java.lang.Exception

addStatusElement

protected org.dom4j.Element addStatusElement()

Creates the status element including attributes.

getResponseDocument

public org.dom4j.Document getResponseDocument()

Returns:

Returns the responseDocument.

setStatus

public void setStatus(Status status)

Sets the status in the response.

Parameters:

status - The status to set.

setStatusReturnCode

public void setStatusReturnCode(int rc)

Sets the return code in the response.

Parameters:

rc - return code

getStatusReturnCode

public java.lang.String getStatusReturnCode()

Gets the return code in the response.

Returns:

return code

setStatusText

public void setStatusText(java.lang.String msg)

Sets the status text in the response.

Parameters:

msg - status text

getStatusText

public java.lang.String getStatusText()

Gets the status text in the response.

Returns:

status text

isStatusSuccess

protected boolean isStatusSuccess()

Returns if this result indicates success.

Returns:

true if success, false if an error or unknown

getResponseElement

protected org.dom4j.Element getResponseElement()

Returns:

Returns the responseElement.

main

public static void main(java.lang.String[] args)
                 throws java.io.IOException,
                        B2bException

Used for testing only.

Throws:

java.io.IOException

B2bException