org.openspml.v2.msg.spml
Class Response

java.lang.Object
  org.openspml.v2.util.xml.BasicMarshallableElement
      org.openspml.v2.msg.spml.Extensible
          org.openspml.v2.msg.spml.ExtensibleMarshallable
              org.openspml.v2.msg.spml.Response

All Implemented Interfaces:

Marshallable, MarshallableElement, OpenContentContainer

Direct Known Subclasses:

AddResponse, org.openspml.v2.msg.pass.BasicPasswordResponse, org.openspml.v2.msg.spmlasync.BasicResponse, org.openspml.v2.msg.spmlbulk.BasicResponse, org.openspml.v2.msg.spmlsearch.BasicResponse, org.openspml.v2.msg.spmlsuspend.BasicResponse, org.openspml.v2.msg.spmlupdates.BasicResponse, BatchResponse, DeleteResponse, ListTargetsResponse, LookupResponse, ModifyResponse

public class Response

extends org.openspml.v2.msg.spml.ExtensibleMarshallable

Author:

kent.spaulding@sun.com

Date: Jan 26, 2006

Field Summary

static java.lang.String

code_id

Constructor Summary

	Response()
	Response(StatusCode status)
	Response(StatusCode status, java.lang.String requestId)
protected	Response(java.lang.String[] errorMessages, StatusCode status, java.lang.String requestId, ErrorCode errorCode)

Method Summary

void	addErrorMessage(java.lang.String errorMessage)
void	clearErrorMessages()
boolean	equals(java.lang.Object o)
java.lang.String	getElementName() This should return the name of the element to be placed in the XML
ErrorCode	getError()
java.lang.String[]	getErrorMessages()
java.lang.String	getRequestID()
StatusCode	getStatus()
int	hashCode()
boolean	removeErrorMessage(java.lang.String errorMessage)
void	setError(ErrorCode error)
void	setRequestID(java.lang.String requestID)
void	setStatus(StatusCode status)
java.lang.String	toXML(XMLMarshaller m) Visitor pattern - dispatch this type to the visitor (m) please.

Methods inherited from class org.openspml.v2.msg.spml.Extensible

addOpenContentAttr, addOpenContentAttr, addOpenContentElement, findOpenContentAttrValueByName, findOperationalAttrByName, findOperationalNVPByName, getNamespacesInfo, getOpenContentAttrs, getOpenContentElements, getOpenContentElements, isValid, removeAllOperationalNVPsWithName, removeOpenContentAttr, removeOpenContentElement, setOpenContent, setOpenContentAttrs, setOpenContentElements

Methods inherited from class org.openspml.v2.util.xml.BasicMarshallableElement

getElementName

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.openspml.v2.msg.MarshallableElement

getNamespacesInfo, isValid

Field Detail

code_id

public static final java.lang.String code_id

See Also:

Constant Field Values

Constructor Detail

Response

public Response()

Response

protected Response(java.lang.String[] errorMessages,
                   StatusCode status,
                   java.lang.String requestId,
                   ErrorCode errorCode)

Response

public Response(StatusCode status)

Response

public Response(StatusCode status,
                java.lang.String requestId)

Method Detail

getErrorMessages

public java.lang.String[] getErrorMessages()

addErrorMessage

public void addErrorMessage(java.lang.String errorMessage)

removeErrorMessage

public boolean removeErrorMessage(java.lang.String errorMessage)

clearErrorMessages

public void clearErrorMessages()

getStatus

public StatusCode getStatus()

setStatus

public void setStatus(StatusCode status)

getRequestID

public java.lang.String getRequestID()

setRequestID

public void setRequestID(java.lang.String requestID)

getError

public ErrorCode getError()

setError

public void setError(ErrorCode error)

toXML

public java.lang.String toXML(XMLMarshaller m)
                       throws Spml2Exception

Description copied from interface: Marshallable

Visitor pattern - dispatch this type to the visitor (m) please.

Throws:

Spml2Exception

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class Extensible

hashCode

public int hashCode()

Overrides:

hashCode in class Extensible

getElementName

public java.lang.String getElementName()

Description copied from interface: MarshallableElement

This should return the name of the element to be placed in the XML

Specified by:

getElementName in interface MarshallableElement

Overrides:

getElementName in class BasicMarshallableElement