net.rim.device.api.io.parser.soap
Class SOAPEnvelope

java.lang.Object
  extended by net.rim.device.api.io.parser.soap.SOAPElement
      extended by net.rim.device.api.io.parser.soap.SOAPEnvelope

public class SOAPEnvelope
extends SOAPElement

Root object in the SOAP object model. It contains a header and a body, which may contain other SOAP elements.

Since:
BlackBerry API 6.0.0

Constructor Summary
SOAPEnvelope()
          Constructs a SOAPEnvelope.
 
Method Summary
 SOAPBody getBody()
          Returns the SOAP body for this SOAPEnvelope.
 SOAPHeader getHeader()
          Returns the SOAP header for this SOAPEnvelope.
 int getStyle()
          Returns the SOAP style.
 int getVersion()
          Returns the SOAP version.
 void setBody(SOAPBody body)
          Updates the SOAP body for this SOAPEnvelope.
 void setHeader(SOAPHeader header)
          Updates the SOAP header for this SOAPEnvelope.
 void setStyle(int style)
          Updates the SOAP version for this envelope.Supported versions are defined as constants in the SOAPConstants class.
 void setVersion(int version)
          Updates the SOAP version for this envelope.
 String toSoapRequest()
          Builds a SOAP XML string for this SOAPEnvelope.
 
Methods inherited from class net.rim.device.api.io.parser.soap.SOAPElement
getAttribute, getAttributes, getName, getNamespace, getType, putAttribute, setAttributes, setName, setNamespace, setType
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

SOAPEnvelope

public SOAPEnvelope()
Constructs a SOAPEnvelope.

Since:
BlackBerry API 6.0.0


Method Detail

getHeader

public SOAPHeader getHeader()
Returns the SOAP header for this SOAPEnvelope.

Returns:
SOAP header for this SOAPEenvelope.
Since:
BlackBerry API 6.0.0

setHeader

public void setHeader(SOAPHeader header)
Updates the SOAP header for this SOAPEnvelope.

Parameters:
header - SOAP header for this SOAPEnvelope.
Since:
BlackBerry API 6.0.0

getBody

public SOAPBody getBody()
Returns the SOAP body for this SOAPEnvelope.

Returns:
SOAP body for this SOAPEnvelope.
Since:
BlackBerry API 6.0.0

setBody

public void setBody(SOAPBody body)
Updates the SOAP body for this SOAPEnvelope.

Parameters:
body - SOAP body for this SOAPEnvelope.
Since:
BlackBerry API 6.0.0

getVersion

public int getVersion()
Returns the SOAP version. Supported versions are defined as constants in the SOAPConstants class. Currently supports these versions:

Returns:
SOAP version.
See Also:
SOAPConstants
Since:
BlackBerry API 6.0.0

setVersion

public void setVersion(int version)
Updates the SOAP version for this envelope. Supported versions are defined as constants in the SOAPConstants class. Currently supports these versions:

Parameters:
version - SOAP version.
See Also:
SOAPConstants
Since:
BlackBerry API 6.0.0

getStyle

public int getStyle()
Returns the SOAP style. Supported versions are defined as constants in the SOAPConstants class. Currently supports these versions:

Returns:
The SOAP style.
Since:
BlackBerry API 6.0.0

setStyle

public void setStyle(int style)
Updates the SOAP version for this envelope.Supported versions are defined as constants in the SOAPConstants class. Currently supports these versions:

Parameters:
style - SOAP style
See Also:
SOAPConstants
Since:
BlackBerry API 6.0.0

toSoapRequest

public String toSoapRequest()
Builds a SOAP XML string for this SOAPEnvelope.

Returns:
String containing SOAP XML for this SOAPEnvelope.
Since:
BlackBerry API 6.0.0





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.